Timeline for At what stage of a project should documentation be done?
Current License: CC BY-SA 3.0
18 events
| when toggle format | what | by | license | comment | |
|---|---|---|---|---|---|
| Feb 15, 2013 at 16:08 | vote | accept | rahules | ||
| Feb 15, 2013 at 7:12 | comment | added | rahules | @Philip I had asked the same thing when I was confirming it, and they said that they needed something that a future developer could refer. Basically, they need a document which would explain how everything works and how it's accomplished. The problem is that there is no MVC or anything. Each file contains code for both processing and UI. So, I'm kind of confused how to structure the document. | |
| Feb 14, 2013 at 22:24 | comment | added | Philip | @rahules And just what the hell does "code documentation" mean? It is a sheet of paper with a single line: "We wrote it in PHP"? Come on man, CHAT with the client and find out what his expectations are. Don't pretend that you or he know what the industry standard is. | |
| Feb 14, 2013 at 21:28 | comment | added | rahules | I've confirmed with them and it's the code documentation. | |
| Feb 14, 2013 at 21:10 | comment | added | Doc Brown | You are just "assuming" that your client means code documentation, but you are not sure? Seriously? Honestly, your first way of "documenting this project" should be to clarify that. No excuses. Next time you meet your client. | |
| Feb 14, 2013 at 18:08 | comment | added | Philip | I'm pretty sure "user documentation" is a users manual. Instructions on how to use the finished product. Does that make "code documentation" everything else? | |
| Feb 14, 2013 at 16:15 | history | tweeted | twitter.com/#!/StackProgrammer/status/302088646880800768 | ||
| Feb 14, 2013 at 16:13 | comment | added | rahules | @Daenyth Yes, I'm using svn | |
| Feb 14, 2013 at 15:39 | history | edited | gnat | CC BY-SA 3.0 | clarification copied into question from comments |
| Feb 14, 2013 at 15:39 | answer | added | Philip | timeline score: 9 | |
| Feb 14, 2013 at 15:37 | comment | added | Daenyth | You mention change logs... are you using version control software? If you're not, start. Right now. Today. Before you write any more code. | |
| Feb 14, 2013 at 15:35 | comment | added | rahules | It is the code documentation. Although I'm assuming this since they haven't specified anything. | |
| Feb 14, 2013 at 15:26 | review | First posts | |||
| Feb 14, 2013 at 15:39 | |||||
| Feb 14, 2013 at 15:19 | answer | added | Sol | timeline score: 4 | |
| Feb 14, 2013 at 15:12 | comment | added | yannis | Are we talking about user documentation or code documentation (or both)? | |
| Feb 14, 2013 at 15:10 | history | edited | yannis | CC BY-SA 3.0 | added 4 characters in body |
| Feb 14, 2013 at 15:10 | comment | added | Florian Margaine | The worst part: documentation. | |
| Feb 14, 2013 at 15:07 | history | asked | rahules | CC BY-SA 3.0 |