Timeline for How should I choose the right documentation for my team?
Current License: CC BY-SA 3.0
5 events
| when toggle format | what | by | license | comment | |
|---|---|---|---|---|---|
| Jun 16, 2020 at 10:01 | history | edited | CommunityBot |
Commonmark migration
|
|
| Feb 7, 2012 at 6:13 | vote | accept | Mithir | ||
| Feb 5, 2012 at 11:50 | comment | added | S.Robins |
+1 for "Produce no document unless it's need is immediate and significant.". In building APIs, I find the tests the best place to go to show literally how each part of an API should be used. The difficulty is sometimes knowing when to start, which is where a very broad concept document or diagram is probably the minimum documentation I've found is needed to reduce the learning curve. Having a good project/issue tracker with a built-in wiki also helps to document the code in a more abstract form, allowing expansion when the team decides it's needed.
|
|
| Feb 5, 2012 at 11:08 | history | edited | pdr | CC BY-SA 3.0 |
edited body
|
| Feb 5, 2012 at 10:50 | history | answered | pdr | CC BY-SA 3.0 |