You can edit almost every page by Creating an account and confirming your email.

DDLC

From EverybodyWiki Bios & Wiki


File:Document Development Life Cycle.jpg
DDLC

Document Development Life Cycle (DDLC) is considered the complete life cycle of a documentation task. Software documentation requires a well-defined methodology for successful completion. DDLC should encompass and go along with Software Development Life Cycle (SDLC) because both are parallel as well as intertwined.

Requirement analysis

Requirement Analysis is an important phase of the Document Development Life Cycle. In this phase, the technical writer gathers useful material for the project and understands and analyzes all the information about the project.

It is the first stage of DDLC in which a technical writer analyzes the document requirement, targeted audience, and documentation tools for throughout use. Intended for the audience level, the technical writer will decide the complexity and depth of the document. Use of language level will be decided at this stage.

The process involves a lot of effort. Information is collected from various sources connected with the project, mainly with the subject-matter expert (SME) and the software developers. To learn the features of the new product, technical writers resolve all queries and problems regarding the project with the help of SMEs and software developers. The earlier versions of the document, if they exist, can also be reviewed for better understanding of the project. Technical writers also search for related information on online libraries and from company resources and gather updated information.

Technical writers must understand the software from the technical point of view. Technical writers must use and test the software product in various ways to get a detailed idea about it. They then list down all the queries and problems faced while studying or understanding the product. They are expected to do their homework and prepare questionnaires related to the project before meeting and interviewing important people in the project. They may have to meet the people involved a number of times to arrive at a comprehensive understanding of the project. At the end of this phase, a technical writer must have resolved all the problems and queries in terms of documenting this understanding for a specific audience.

Designing

At this stage, some estimates are decided, such as approximate pages, document format, representation styles, etc. Subject knowledge, good writing skills, and sufficient information about the project will help the technical writer create a quality document.

Developing the content

At this stage, content is developed as per the design perspective and in accordance with the planning of the documents at previous stages. A smart technical writer will use graphical illustrations to provide a better understanding for the end reader.

Editing/proof-reading

At this stage, the document is thoroughly read by the writer and also verified by a third party. It checks for all sorts of grammatical errors. This verification ensures that the document is ready for publishing. Also, the document needs to be reviewed by the concerned developers / business analysts before it is published to the end users.

Maintenance

At this stage, collection of further updates and modification is done. Also, time to time updated backups are taken.

References

See also


This article "DDLC" is from Wikipedia. The list of its authors can be seen in its historical. Articles copied from Draft Namespace on Wikipedia could be seen on the Draft Namespace of Wikipedia and not main one.