7/27/2015 www.sudrocks.ucoz.com2 TERM PAPER PRESENTATION TOPIC DDLC:-DOCUMENT DEVELOPMENT LIFE CYCLE CAP-314(SOFTWARE ENGG.) Made by:- sudarshan kumar. - презентация

1

2 7/27/ TERM PAPER PRESENTATION TOPIC DDLC:-DOCUMENT DEVELOPMENT LIFE CYCLE CAP-314(SOFTWARE ENGG.) Made by:- sudarshan kumar RD3801A31 TOPIC DDLC:-DOCUMENT DEVELOPMENT LIFE CYCLE CAP-314(SOFTWARE ENGG.) Made by:- sudarshan kumar RD3801A31

3 ACKNOWLEDGEMENT I am vert thankfull to my class teacher MISS JASVEEN KALRA for helping me and motivating through out the project.Without whose help completion of this project was not possible.I m also very thankfull to my friends who supported me at every step of project.Thank you all 7/27/2015 Free template from

4 Contents Introduction. Why we avoid this. Ddlc through diagram Steps in Ddlc Advantages Q&A Introduction. Why we avoid this. Ddlc through diagram Steps in Ddlc Advantages Q&A 7/27/2015 download this ppt from

5 Introduction Document Development Life Cycle (DDLC) is considered as the complete life cycle of a documentation task. Software documentation requires a well defined methodology for the successful completion. DDLC should encompass and go along with Software Development Life Cycle (SDLC) because both are parallel as well as intertwined.methodologySoftware Development Life CycleSDLC Software documentation or source code documentation is written text that accompanies computer software. It either explains how it operates or how to use it, and may mean different things to people in different roles. computersoftware Document Development Life Cycle (DDLC) is considered as the complete life cycle of a documentation task. Software documentation requires a well defined methodology for the successful completion. DDLC should encompass and go along with Software Development Life Cycle (SDLC) because both are parallel as well as intertwined.methodologySoftware Development Life CycleSDLC Software documentation or source code documentation is written text that accompanies computer software. It either explains how it operates or how to use it, and may mean different things to people in different roles. computersoftware 7/27/2015 download this ppt from

6 Types of documents Requirements - Statements that identify attributes, capabilities, characteristics, or qualities of a system. This is the foundation for what shall be or has been implemented. Architecture/Design - Overview of software. Includes relations to an environment and construction principles to be used in design of software components. Technical - Documentation of code, algorithms, interfaces, and APIs. End User - Manuals for the end-user, system administrators and support staff. Marketing - How to market the product and analysis of the market demand. Requirements - Statements that identify attributes, capabilities, characteristics, or qualities of a system. This is the foundation for what shall be or has been implemented. Architecture/Design - Overview of software. Includes relations to an environment and construction principles to be used in design of software components. Technical - Documentation of code, algorithms, interfaces, and APIs. End User - Manuals for the end-user, system administrators and support staff. Marketing - How to market the product and analysis of the market demand. 7/27/2015 download this ppt from

7 Why we avoid this? You think you've got the design in your head The person who asked for the program needs it urgently It seems boring, and is unnecessary paperwork You might find out things youd rather not know about – for example that the problem is more complex than originally anticipated Somebody sent you an giving a rough idea of what they want, so that's a design isn't it? You think you've got the design in your head The person who asked for the program needs it urgently It seems boring, and is unnecessary paperwork You might find out things youd rather not know about – for example that the problem is more complex than originally anticipated Somebody sent you an giving a rough idea of what they want, so that's a design isn't it? 7/27/2015 download this ppt from

8 Ddlc through diagram 7/27/2015 download this ppt from

9 Steps in Ddlc Requirement analysis Designing Developing Testing Publishing Maintaince Requirement analysis Designing Developing Testing Publishing Maintaince 7/27/2015 download this ppt from

10 Requirement analysis Requirement Analysis is an important phase of the Document Development Life Cycle. In this phase the technical writer gathers the useful material for the project and understands and analyzes all the information of the project. The process involves lot of efforts. The 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 writer resolves all the queries and problems regarding the project with the help of SME and software developers. The earlier versions of the doucment, if exists, can also be reviewed for better understanding of the project. Technical writer also searches the related information on online libraries and from the company resource and gathers updated information. Requirement Analysis is an important phase of the Document Development Life Cycle. In this phase the technical writer gathers the useful material for the project and understands and analyzes all the information of the project. The process involves lot of efforts. The 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 writer resolves all the queries and problems regarding the project with the help of SME and software developers. The earlier versions of the doucment, if exists, can also be reviewed for better understanding of the project. Technical writer also searches the related information on online libraries and from the company resource and gathers updated information. 7/27/2015 download this ppt from

11 Designing This phase is very important as it creates the skeleton for the document. Right from the cover page to summary to Table of Content (TOC) to actual text to glossary to Index, here a design is created. For example, if you are using Microsoft Word 2007, then you just need to place the skeletons of TOC and Index. Later as you keep writing, these tables get updated provided you click update option. In the design phase, you have all the structure ready and only the content is missing. Once you are ready with design, a rough view of document's shape starts emerging. This phase is very important as it creates the skeleton for the document. Right from the cover page to summary to Table of Content (TOC) to actual text to glossary to Index, here a design is created. For example, if you are using Microsoft Word 2007, then you just need to place the skeletons of TOC and Index. Later as you keep writing, these tables get updated provided you click update option. In the design phase, you have all the structure ready and only the content is missing. Once you are ready with design, a rough view of document's shape starts emerging. 7/27/2015 download this ppt from

12 Developing This phase is the actual writing phase. If you were writing a rough document, you would have started from this phase and ended here only. Here actual text is written and if TOC and Index is being maintained, the titles, book marks, references are established along with writing. Writing also means placing tables, images, titles, notes, detailed elaboration etc. The development phase although enjoys the central place, still it shines when associated and mapped with rest of the phases exactly as planned. This phase is the actual writing phase. If you were writing a rough document, you would have started from this phase and ended here only. Here actual text is written and if TOC and Index is being maintained, the titles, book marks, references are established along with writing. Writing also means placing tables, images, titles, notes, detailed elaboration etc. The development phase although enjoys the central place, still it shines when associated and mapped with rest of the phases exactly as planned. 7/27/2015 download this ppt from

13 Testing As the title implies, this phase comes after you have written the document and have updated all the tables including TOC and Index. Clicking a particular heading in the TOC must take the control to connected page. Further links and hyperlinks should be well connected and checked. Apart from these tests, grammatical check, punctuation check, and regular flow of sentences, and sensible phrases, are natural test elements. Remember, if a link does not work properly, you can be reprieved, but as a technical writer, any grammatical error or flaw in the flow of sentence cannot be taken lightly by any means. The document for software normally follows a style guide which tells how a title should be written or paragraphs should be framed. So the used of style guide must be adhered by heart. Once tested for aforementioned regulations, a document is sent to the SMEs and Software coders who then read the document between the lines to confirm that what is written is exactly what happens. Any problem reported is communicated to writer who then ensures the veracity of words. As the title implies, this phase comes after you have written the document and have updated all the tables including TOC and Index. Clicking a particular heading in the TOC must take the control to connected page. Further links and hyperlinks should be well connected and checked. Apart from these tests, grammatical check, punctuation check, and regular flow of sentences, and sensible phrases, are natural test elements. Remember, if a link does not work properly, you can be reprieved, but as a technical writer, any grammatical error or flaw in the flow of sentence cannot be taken lightly by any means. The document for software normally follows a style guide which tells how a title should be written or paragraphs should be framed. So the used of style guide must be adhered by heart. Once tested for aforementioned regulations, a document is sent to the SMEs and Software coders who then read the document between the lines to confirm that what is written is exactly what happens. Any problem reported is communicated to writer who then ensures the veracity of words. 7/27/2015 download this ppt from

14 Publishing Once all the text is well framed, managed, and proof read, it is ready for publishing. If the document is going to be published outside the company, it's suggested to take a printout of the document and see how it will look after printing. As once the printing is done at big level, any change will cost too much and also will affect your reputation as a technical writer because the writer is not just responsible for creating docs but also for the proper formatting. The writer must ensure that the document is apt for reading and suits the eyes of reader. Font selection, size choice, and usage of brightness in pictures are few points that can turn an odd looking document into a masterpiece. 7/27/2015 download this ppt from

15 Maintaining As usual, this is the longest and perhaps never ending phase. It includes addition, deletion, and update of the document. If more features are added to the software, they must be added in a highlighting manner so that existing readers can directly pay attention to the newly added stuff. In case if the authoring tool has been upgraded, the writer must learn new features and incorporate them into existing document and so on. The a forementioned phases have always been followed but in an unknowingly manner. Now we have an idea, why not stick to the phases and ensure that the output is absolutely wonderful and professional. As usual, this is the longest and perhaps never ending phase. It includes addition, deletion, and update of the document. If more features are added to the software, they must be added in a highlighting manner so that existing readers can directly pay attention to the newly added stuff. In case if the authoring tool has been upgraded, the writer must learn new features and incorporate them into existing document and so on. The a forementioned phases have always been followed but in an unknowingly manner. Now we have an idea, why not stick to the phases and ensure that the output is absolutely wonderful and professional. 7/27/2015 download this ppt from

16 7/27/2015 download this ppt from