1 / 18

Program Documentation

Program Documentation. Skill Area 307. Materials Prepared by Dhimas Ruswanto , BMm. Lecture Overview. Program Documentation Characteristics of Good Documentation Types of Documentation Stages of Document Preparation. Program Documentation.

coral
Download Presentation

Program Documentation

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript


  1. Program Documentation Skill Area 307 Materials Prepared by DhimasRuswanto, BMm

  2. Lecture Overview • Program Documentation • Characteristics of Good Documentation • Types of Documentation • Stages of Document Preparation

  3. Program Documentation • The program documentation is a kind of documentation that gives a comprehensive procedural description of a program. • It shows as to how software is written. • The program documentation describes what exactly a program does by mentioning about the requirements of the input data and the effect of performing a programming task.

  4. Program Documentation • Documentation are needed to ensure that we are able to communicate effectively, with all the people who will be involved in the development of the program or system. • A good documentation will help the user to save their time from spending lots of unnecessary time trying to figure out how to use your program.

  5. Characteristics of Good Documentation • A good documentation is: • Accessible • Readable • Understandable • Correct • Controlled

  6. Accessible • Documentation is useless unless it is possible to use it to answer questions. • Users need to find the required document and the appropriate section to solve a specific problem. • The document needs to have the following in order to be accessed and found quickly: • A clear structure (proper use of folders and names) • A table of content • Detailed index • To be catalogued

  7. Readable • Should be written to suit the knowledge and level of understanding of the user • Also written in a more personal style and should not assume they are technical expertise

  8. Understandable • Documentation is intended to convey information to the reader. • This can only be done if the reader is able to understand the text. • The writer should have a very clear idea about what can be expected by the reader

  9. Correct • You need to decide two things: • Is this the right things to document? • Is this documentation correct? • Correctness requires testing by means of peer view (colleagues). • No documentation should ever be released without such a review because event the best document writer make mistake and it is difficult to find one’s own mistakes.

  10. Controlled • All programs are subject to change and this includes documentation. • Extreme confusion can be caused by mixing up different and incompatible versions of program code, documentation and any other deliverables from the development process.

  11. Types of Documentation

  12. Types of Documentation

  13. Document Production • Document production is the process of creating a document and formatting it for publication. • The document production process as being split into 3 stages: • Document creation • Document polishing • Document production

  14. Document Creation • The initial input of the information in the document. • This is supported by word processors and text formatters, table and equation processors, drawing and art packages.

  15. Document Polishing • This process involves improving the writing and presentation of the document to make it more understandable and readable. • This involves finding and removing spelling, punctuation and grammatical errors, detecting clumsy phrases and removing redundancy in the text. • The process may be supported by tools such as on-line dictionaries, spelling checkers, grammar and style checkers and style checkers.

  16. Document Production • This is the process of preparing the documentfor professional printing. • It is supported by desktop-publishing packages, artwork packages and type styling programs.

  17. 3 Stages of Document Preparation

  18. END

More Related