My take on the DDLC
I come across this question often enough from tech writer newbies who are green behind the ears. Most of these writers have faced a few interviews, and have come to realize that they would need to start at the basics. And since the basics start with processes lets start with that. I’ll first put down my thoughts and then provide a few links. Anyone wanting to know more, is most welcome to mail me. Leave me your email address as a comment, I promise to get back :)
The way I see it, the writing process is more or less like the SDLC (ah, please google for information on that) and it would almost always coincide with the DDLC. The table below gives you an idea about how I perceive
Phase: Analysis
- Figure out documentation requirements
- If it’s the first time the document is being developed - create and understand the user profile
- Understand and plan for document output
- Create documentation plan
- Based on output, get the tools, resources, and people
- Submit plan for review and approval
Deliverables
- User Analysis
- Project plan
- Project reports
Phase: Design
- Establish document/content specs
- Create detailed outline
- Estimate pages/graphics
- Plan/prepare style guide
- Create templates needed for the output
- Design the prototype (If it’s the first time the document is being developed)
- Revise project plan if required
Deliverables
- Detailed outline
- Project plan revisions
- Progress reports
Phase: Development
- Create prototype (If it’s the first time the document is being developed)
- Get approval
- Complete and publish style guide
- Create drafts for review
- Create graphics
- Revise and edit drafts
- Obtain approval
- Track hours, milestones
Deliverables
- Prototype
- Style guide
- Drafts with graphics
- Progress reports
Phase: Implementation
- Create appendices, glossary, index
- Final edit reviews
- Test the documents for technical accuracy
- Test the document functionality
- Test the document usability
- Provide final revisions and QA
- Obtain final approval
- Obtain client approval/sign-off
Deliverables
- Final drafts with graphics
- Progress reports
Phase: Finalization/ Wrap-up
- Prepare production requirements
- Oversee production, packaging, distribution
- Hold project wrap-up meeting
- Create and implement customer surveys, feedback
- Determine maintenance/update requirements
Deliverables
- Camera-ready copies with graphics, appendices, index, table of contents
- Production copies
- Progress reports
- Project wrap-up report
These are some links for further reading:
http://srmwww.gov.bc.ca/imb/3star/sdlc/stds4.html
http://www.stcatlanta.org/newsletters/january05.htm
http://twin-india.org/html/downloads/DDLC%20and%20SDLC.ppt
0 Comments:
Post a Comment
<< Home