Treat the writing process like the coding process
January 31, 2009Some time ago David H (Lone Writers SIG email discussion list) made this point about the processes of writing and coding (programming) and the time it takes for both. Here’s his take on it:
… I point out to the project manager that the programmers have had months to study the feasibility of the application, design the interface, build the engine, develop meaningful functionality, test the usability, and decide on the most efficient means of deployment. Then I add that the same considerations must be performed for the documentation, and that he can’t limit the documentation process to less than half the time of the coding process.
At least it plants the thought in the project manager’s mind that if he wants quality documentation, he’s got to treat the writing process like he treats the coding process.
I totally agree!
[...] I couldn’t let the opportunity go by to add something about allowing sufficient time for documentation too, especially as this documentation was also customized for the client. (Note: There were some 20+ developers and implementers on this project, with a part-time tester and a part-time technical writer [me]. I’ve written before about treating the documentation writing process like the code writing process…) [...]