Dokumentowanie decyzji projektowych – o ADR i RFC
Artykuł wyjaśnia, czym są ADR i RFC – dokumenty do utrwalania decyzji projektowych i architektonicznych w procesie wytwarzania oprogramowania.
Artykuł wyjaśnia, czym są ADR i RFC – dokumenty do utrwalania decyzji projektowych i architektonicznych w procesie wytwarzania oprogramowania.
Autor wraca do projektu Doco, generatora dokumentacji dla TypeScript/JavaScript, omawiając jego założenia i funkcje po nieudanym konkursie programistycznym.
Poradnik jak poprawnie tworzyć pliki README.md na GitHubie, aby skutecznie prezentować swoje projekty programistyczne.
Omówienie tworzenia dobrej dokumentacji projektów IT, w tym poradniki, przewodniki i referencje, oraz wykorzystanie Read the Docs.
Praktyczny poradnik tworzenia efektywnej dokumentacji README.md dla projektów programistycznych i open source.
Wprowadzenie do Markdown - prostego języka znaczników do tworzenia dokumentacji projektów IT. Omawia jego zalety i podstawową składnię.