Geek Answers Handbook

Recommendations for the storage and organization of documentation?

I am entrusted with the development of basic principles for organizing documentation. Currently, my company uses a mixture of Wiki and random documents, which are either in shared network folders or checked in the source code repository. I know that one size may not fit all, but what are some of the best practices? I would suggest that some documents belong to the source code, and some belong on their own, but this is what I am here to find out. Here is what we have:

  • Requirements
  • Research documents (for example, test results show that we need to optimize an existing application or add a function)
  • Architecture / Design
  • Technical
  • Configuration / Deployment
  • End user

Besides:

  • Features / Demos (For Sale)
  • Vendor documentation (e.g. our hosting provider)

Also - should documents be organized by project (application) or by type (Requirements for the end user)?

thank

+5
source share
3 answers

Documentation - Undervalued Work

Depending on the size of your company, it would probably be less risky if an experienced software engineer did this kind of work. I really don't want to offend you, but I suspect you're not alone.

. , , /, . , (), , 5 .

, ( ). . , , , , , . , -.

, , .

:

  • UML- (, , ..)
  • /
+2

, , , , " ". , , ..

, , , "- ". ( ). , . , , - /docs . ".. " - , - sharepoint, wiki , .

Pay attention to the Configuration / Deployment documentation - it is a good idea to aim to deploy to 100% of the scenarios, in which case the folder / deployment next to your source code is the best documentation for everyone.

0
source

More articles:


All Articles