• 0 Vote(s) - 0 Average
  • 1
  • 2
  • 3
  • 4
  • 5
what is the best workflow to write documntation ?

#3
[eluser]Colin Williams[/eluser]
I typically sketch out my code as sort of an abstract class, and maybe map out the API/workflow in pencil and paper if its complexity necessitates it. Then I take that and start writing the documentation--yes, before completing the code. The documentation basically becomes a road map for development. They grow and change side by side. Sometime what you planned has to change for technical reasons, and other times it becomes unnecessarily difficult to explain the API, so you change the API to make it more simple.


Messages In This Thread
what is the best workflow to write documntation ? - by El Forum - 01-02-2010, 01:51 PM
what is the best workflow to write documntation ? - by El Forum - 01-02-2010, 02:35 PM
what is the best workflow to write documntation ? - by El Forum - 01-02-2010, 04:54 PM
what is the best workflow to write documntation ? - by El Forum - 01-02-2010, 05:07 PM
what is the best workflow to write documntation ? - by El Forum - 01-02-2010, 10:53 PM
what is the best workflow to write documntation ? - by El Forum - 01-03-2010, 01:56 PM
what is the best workflow to write documntation ? - by El Forum - 01-04-2010, 04:33 PM
what is the best workflow to write documntation ? - by El Forum - 01-05-2010, 10:17 AM
what is the best workflow to write documntation ? - by El Forum - 01-06-2010, 08:41 AM

Digg   Delicious   Reddit   Facebook   Twitter   StumbleUpon  


  Theme © 2014 iAndrew  
Powered By MyBB, © 2002-2021 MyBB Group.