Developers like to complain about the lack of documentation. They complain even more when they have to write it. I gathered my advice on how to successfully do documentation without the maintenance burden.
Prezentacja frameworka, który wspomoże nas w tworzeniu przejrzystej i funkcjonalnej dokumentacji dla API.
On of the hardest parts of getting an open source project into state which allows others to use it effectively is creating documentation. This post shows how you can generate documentation directly from source code by using DocFx.
Dokument analityczny to ważny element projektu. To jak zostanie napisany decyduje o satysfakcji klienta. W tym wpisie opisałem swoje doświadczenia i przemyślenia wraz z odpowiedzią na pytanie „dlaczego dokument analityczny powinien przedstawiać projekt w negatywnym świetle”. Zapraszam do lektury!
APIs are used in every application. It is worth to take care of API documentation
Software Architecture: design and documentation In my previous article I tried to present the role of the application architect on a general level. Today I’d like to focus on his specific aspects of his work, without which the term “architect” wouldn’t make any sense.Design and documentation A common image of architect’s work, consisting in drawing and describing blocks, puts two activities of design and documentation in one pot. Meanwhile, these are two independent activities. To explain why I...
Architektura 3879 dni, 10 godzin, 58 minut temu 122 źrodło rozwiń
Proste, lekkie narzędzie do generowania dokumentacji HTML/CHM na podstawie zestawów .NET i plików XML. Projekt tworzony w języku C#. Alternatywa dla Sandcastle ;)