This'll be a sort of abridged summary of the topic, any more information you might need, I recommend you try the book (name in bottom of the post). In the professional realm documentation is everything (according to this book, it's probably true), lack thereof can make your job a living nightmare every time there's an update. Even if tedious proper documentation can go a long way. In Dines' Book there are 3 main types of documentation, each different but of equal importance. Informative Documentation Descriptive Documentation Analysis Documentation It can get a bit tricky trying to differentiate them so let me try to explain it. Informative Documents are basically documents where you talk about the domain and everything involving it (like partners, place, the scope, etc) without necessarily going into detail about the technical stuff involved in your domain. In an informative document you can find the following: Descriptive Documents ...
Comments
Post a Comment