Scribd Logo
Upload

Welcome to Scribd!

  • Checklist

    Uploaded by

    Erik Jørgensen
    5 views2 pages
    This document is a checklist for documentation requirements that covers: 1) The type of documentation needed such as procedural, reference material, or tutorials. 2) Whether the content and examples are significant. 3) The level of coverage desired such as exhaustive or brief. 4) If the existing house style should be followed and if translation is needed. 5) Whether a glossary should be included. 6) The preferred online formats like HTML Help, HTML, or PDF. It also requests any additional comments to help evaluate the documentation needs.

    Original Description:

    Original Title

    checklist

    Copyright

    © Attribution Non-Commercial (BY-NC)

    Available Formats

    DOC, PDF, TXT or read online from Scribd

    Did you find this document useful?

    Is this content inappropriate?

    Report this Document
    This document is a checklist for documentation requirements that covers: 1) The type of documentation needed such as procedural, reference material, or tutorials. 2) Whether the content and examples are significant. 3) The level of coverage desired such as exhaustive or brief. 4) If the existing house style should be followed and if translation is needed. 5) Whether a glossary should be included. 6) The preferred online formats like HTML Help, HTML, or PDF. It also requests any additional comments to help evaluate the documentation needs.

    Copyright:

    Attribution Non-Commercial (BY-NC)
    Download as DOC, PDF, TXT or read online from Scribd
    Flag for inappropriate content
    5 views2 pages

    Checklist

    Uploaded by

    Erik Jørgensen
    This document is a checklist for documentation requirements that covers: 1) The type of documentation needed such as procedural, reference material, or tutorials. 2) Whether the content and examples are significant. 3) The level of coverage desired such as exhaustive or brief. 4) If the existing house style should be followed and if translation is needed. 5) Whether a glossary should be included. 6) The preferred online formats like HTML Help, HTML, or PDF. It also requests any additional comments to help evaluate the documentation needs.

    Copyright:

    Attribution Non-Commercial (BY-NC)
    Download as DOC, PDF, TXT or read online from Scribd
    Flag for inappropriate content
    of 2

    ECC

    Documentation Requirements Checklist

    General Documentation
    1. Type of documentation:
    Procedural (overall top-level tasks, without much detail about specific fields)

    Reference material (explanation of fields, examples, technical details, etc.)

    Conceptual material (background information that users need to know)

    Tutorial (step-by-step worked examples that users can follow)


    Other, for example, quick-reference card, wall chart: ___________________

    2. Is the content of data and examples significant?


    No

    Yes

    3. What level of coverage are you seeking?

    Exhaustive, all features explained in detail

    80:20, the most common features only

    Brief information, sufficient just to get going

    Is there an existing house style that should be followed?

    No

    Yes

    4. Will the documentation be translated into other languages?


    No

    Yes

    5. Should a glossary of terms or vocabulary be included in this type of


    documentation?

    No

    Yes

    6. What online formats do you want?:


    Compiled HTML Help (*.CHM, Microsoft proprietary help)

    Pure HTML

    WebHelp (cross-platform HTML-based help with Contents, Index, Search)

    Microsoft Word
    ECC
    Documentation Requirements Checklist
    Adobe PDF
    Others: ___________________

    Additional comments
    Please supply any other information that will help evaluate the documentation needs.

    You might also like