July 25, 2012

Process for online help development



Jotting down the process flow that suits me and team while developing online help during one of my project. Hope it may help you, trying to keep it simple and less technical:-) 



Task
Description
1
New features
Familiarize oneself with the new features
2
Writing instructions
Write the entire Online Help
3
Capture images
Capture Online Help images
4
MAP Ids
Define MAP Ids for new pages
5
First draft ready
Send for review/Receive comments

Testing
Start testing new pages
6
Revisions
Make all the necessary changes
7
Second draft ready
Send for review/Receive comments
8
Revisions
Make all the necessary changes
9
Update images
Recapture images based on feature changes
10
Index keywords
Define index keywords for new pages
11
Japanese version
Generate and check Japanese version
12
Final draft ready
Send for review/Acceptance
13
Language check
Generate documents/send for language check
14
Revisions
Make all the necessary changes
15
Final version ready



The progress of the implementation influence the writing instructions usually feature change during implementation.So help must also be updated during implementation.

If you are interested to know which is the best online help click here.
Post a Comment