Dokumentacja techniczna - jak wygląda ?

Question

Cześć!
Zastanawiało mnie jak wygląda dokumentacja techniczna, jak się z nią pracuje, co tam jest itp.

Ktoś coś ?

Answer 1

Tu masz ciekawy artykuł na ten temat
http://4pm.pl/artykuly/dokumentacja-jak-to-sie-je
https://pl.wikipedia.org/wiki/Dokumentacja_programu

Answer 2

Polecam zapoznać się ze standardem JavaDoc, z którego wywodzą się phpDoc i jsDoc, które są de facto standardami tworzenia tego typu dokumentacji. Całość sprowadza się do wstawiania odpowiednich komentarzy do kodu, z których następnie odpowiednie narzędzia (np. jsDuck, jsDoc) generują dokumentacje typu http://docs.ckeditor.com