Scribd Logo
Upload

Welcome to Scribd!

  • Principles of Technical Writing - Workbook

    Uploaded by

    Janmuhammad
    10 views2 pages
    The document discusses 12 principles for technical writing when creating software documentation: 1) Determine the intended users, 2) Understand their information needs, 3) Choose an appropriate style and guidelines, 4) Select a deliverable format, 5) Choose an authoring tool, 6) Structure the content, 7) Select a distribution channel, 8) Write the documentation, 9) Include images/videos, 10) Publish a first version, 11) Collect feedback to improve, and 12) Repeat the process. It provides an exercise for applying the principles to write instructions for launching a calculator app on a mobile phone.

    Original Description:

    Copyright

    © © All Rights Reserved

    Available Formats

    PDF, TXT or read online from Scribd

    Did you find this document useful?

    Is this content inappropriate?

    Report this Document
    The document discusses 12 principles for technical writing when creating software documentation: 1) Determine the intended users, 2) Understand their information needs, 3) Choose an appropriate style and guidelines, 4) Select a deliverable format, 5) Choose an authoring tool, 6) Structure the content, 7) Select a distribution channel, 8) Write the documentation, 9) Include images/videos, 10) Publish a first version, 11) Collect feedback to improve, and 12) Repeat the process. It provides an exercise for applying the principles to write instructions for launching a calculator app on a mobile phone.

    Copyright:

    © All Rights Reserved
    Download as PDF, TXT or read online from Scribd
    Flag for inappropriate content
    Download as pdf or txt
    10 views2 pages

    Principles of Technical Writing - Workbook

    Uploaded by

    Janmuhammad
    The document discusses 12 principles for technical writing when creating software documentation: 1) Determine the intended users, 2) Understand their information needs, 3) Choose an appropriate style and guidelines, 4) Select a deliverable format, 5) Choose an authoring tool, 6) Structure the content, 7) Select a distribution channel, 8) Write the documentation, 9) Include images/videos, 10) Publish a first version, 11) Collect feedback to improve, and 12) Repeat the process. It provides an exercise for applying the principles to write instructions for launching a calculator app on a mobile phone.

    Copyright:

    © All Rights Reserved
    Download as PDF, TXT or read online from Scribd
    Flag for inappropriate content
    Download as pdf or txt
    of 2

    Technical Writing: How to Write Software Documentation

    Principles of Technical Writing

    Principle #1: Decide whom are your writing for!

    Principle #2: Decide on the information needs of your user

    Principle #3: Decide on the way you are going to address your user - which S&Gs to apply

    Principle #4: Decide on the deliverable to create

    Principle #5: Decide on the tool you will use to create your content

    Principle #6: Decide on the structure of your content

    Principle #7: Decide on the information channel you are going to use

    Principle #8: Write the documentation

    Principle #9: Use images and videos as appropriate

    Principle #10: Publish your first version

    Principle #11: Collect input and improve the content

    Principle #12: Repeat

    My Notes
    …………………………………………………………………………………………………………………………………………………………
    …………………………………………………………………………………………………………………………………………………………
    …………………………………………………………………………………………………………………………………………………………
    Technical Writing: How to Write Software Documentation

    Exercise: Write an instruction that will let a beginner user start the calculator application on your
    mobile phone using the principles above:

    1. Who are you writing for? My target user is:


    ………………………………………………………………………………………………………………………………………………
    2. What information does my user need?
    ………………………………………………………………………………………………………………………………………………
    3. I am going to use ………………………………………………………………………………………………………… style.
    4. I am going to develop a ……………………………………………………………………………………… deliverable.
    5. I shall create my instructions using
    ………………………………………………………………………………………………
    6. I shall structure my content in the following way:
    ………………………………………………………………………………………………………………………………………………
    ………………………………………………………………………………………………………………………………………………
    ………………………………………………………………………………………………………………………………………………
    7. Here is my documentation:
    ………………………………………………………………………………………………………………………………………………
    ………………………………………………………………………………………………………………………………………………
    ………………………………………………………………………………………………………………………………………………
    ………………………………………………………………………………………………………………………………………………
    ………………………………………………………………………………………………………………………………………………
    ………………………………………………………………………………………………………………………………………………
    ………………………………………………………………………………………………………………………………………………
    ………………………………………………………………………………………………………………………………………………
    ………………………………………………………………………………………………………………………………………………
    ………………………………………………………………………………………………………………………………………………
    ………………………………………………………………………………………………………………………………………………
    ………………………………………………………………………………………………………………………………………………

    You might also like