Hyderabad Technical WriterA blog for Technical Writing Tips and Tricks, Quick Reference Guides, Technology, Hyderabad, and India
How to Organize your Content?
Right then! The release management team informs you that the development and testing of the new application or the feature is now complete and you have got only a couple of weeks to publish your final documentation deliverables. That are both technically reviewed and editor checked. So are you worried how to organize the information?
You can breath easy and start writing the actual content for your deliverables, which is organized and acts as a set of guidelines for the stakeholders when they refer the documentation deliverables whenever there are in trouble or reviewing them for the first time, if you can organize the content into various parts, which is definite, distinct, and clearly outlined.
Once you have collated all the information right from the kick-off meeting or the notes that you took from different sources: project managers, developers, and testers, to the latest versions of the Software Development Life Cycle (SDLC) documentation that is the, HLDs, DLDs, and marketing collaterals and so on for the new application or the feature. It is always a best practice to perform the audience and task analysis. So that, you can update the content with easy once you have the tasks, which are readily available.
Organizing your content into various parts
Codes
Concepts
Definitions or Glossary
Graphics
Items
Messages
Principles
Procedures
Processes
Related Topics
Structures
Trouble shootings
I will try to explain each of them with suitable example in my future articles till then happy blogging.
Regards,
Vivek
