Alcove’s Technical Writing Services
Alcove’s Technical Writing Methodologies
Our experience of working across domains and clients has helped us to develop our own methodology of a set of standard procedures to execute different kinds of projects.
Alcove’s quality model is based on the Document Development Lifecycle (DDLC). The phase-wise DDLC has been developed carefully to align the documentation development lifecycle with that of the software/product/process/service development/delivery lifecycle to offer best and timely results and outputs of highest quality. |
Requirements Phase: In this phase, the groundwork is prepared by understanding the customer’s requirements, target audience, and the product/process/service.
- Understand the project
- Gather source information
- Interview the Project Manager and other concerned persons
- Go through the demo of the project
- Request for sample documents and other project related documents
- Check the graphics (provided by the client or created/captured by Alcove)
- Review the inputs
- Approval/Signoff
Design phase: In this phase, Table of Contents (TOC), layout design or template, and style guide are created. The design phase is applicable only for ground-up development projects and not for maintenance, enhancement, conversion, or porting projects.
- Create and review TOC
- Create and review style guide or adopt a standard one
- Create and review templates
Development phase: In this phase, depending on the project type, new content is developed, existing content is enhanced, or document is converted from one environment to another.
- Go through the demo of the project
- Interview the SME
- Gather source information
- Test the application or product for functionality
- Request or capture graphics
- Write document content
- Self review
- Update the document, if required
- Verify the document
- Document submitted for approval
Review phase: In this phase, the document is reviewed (self, peer, technical, and final) against the requirements specification document, the template, and the style guide.
- Peer review
- Technical review
- Editorial review
- Final review
Release phase: In this phase, content is released in the desired format and evidence of document closure is procured.
- Release (intermediate/final)
- Soft copy
- Hard copy
- Project completion Signoff
For further information or a service requirement/price quote, please contact us
