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

Related posts:

1. What kind to documents should i write for Java project? I was recently asked how to start documentating for a...
2. What are Preview Release Notes? Preview Release Notes are for a Technology Preview. While this...
3. How to create Release Notes Release Notes cover what’s new, download and installation instructions, known...
4. Write and Maintain your MS Office documents online with Zoho plugin The Zoho Plug-in for Microsoft Office lets you work...
5. Write and Maintain your MS Office documents online with Zoho plugin The Zoho Plug-in for Microsoft Office lets you work...