People email me all the time asking questions about technical writing and other documentation related questions. I was recently asked how to start ‘documentating for a banking solution which is been developed in Java on Open-Source platform. What kind to documents should i write for this project?’ Now, there isn’t much to go on here, so…
It depends on what the client actually wants.
Here’s what I’d do:
1. Ask the person in charge which activities are most important, for example, installing the servers, updating the databases, teaching users and so on.
2. Once you have a list of the most essential activities, discuss with him/her what you believe are most necessary…
3. then you can write books that support these tasks,
Without knowing too much else about the project, I’d say that you need to produce:
•Admin Guides
•User Guides
•Release Notes
•Training Documents
•Installation Guides
If you let me know more about the project, I can give you more concrete answers.
Regards,
Ivan
and you can Twitter me @ivanwalsh
Need help with your web writing? Click here for a Free Quote
Comments on this entry are closed.