Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Development Documentation [closed]

We are a development team and we need to document our code. Each developer works on a part of the code which can be called as a module. We need a documentation that has this specification

  1. It should be easy to implement and use
  2. Each developer documents her/his own work and when another developer needs to know about any module, he/she shouldn't be obliged to ask the original developer about the documentation. He/she should be able to find the document by herself/himself.
  3. We should be able to search through entire documentation.

Have you any suggestion for this?

like image 838
user560224 Avatar asked Nov 28 '25 21:11

user560224


2 Answers

Most languages have a way to produce documentation from code comments. Java and JavaScript both have ways to convert comments into an API specification, such as Java's Javadocs. It really just depends on what platform you're using.

like image 107
jmort253 Avatar answered Dec 01 '25 09:12

jmort253


You talk about design decision, requirements and such?

Why not use a wiki (we use PmWiki) for such collaboration?

like image 41
mtraut Avatar answered Dec 01 '25 10:12

mtraut



Donate For Us

If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!