Last edited by Dougis
Wednesday, August 5, 2020 | History

6 edition of How to write computer documentation for users found in the catalog.

How to write computer documentation for users

by Susan J. Grimm

  • 198 Want to read
  • 28 Currently reading

Published by Van Nostrand Reinhold in New York .
Written in English

    Subjects:
  • Electronic data processing -- Authorship,
  • Computers -- Handbooks, manuals, etc,
  • Technical writing

  • Edition Notes

    StatementSusan J. Grimm.
    ContributionsGrimm, Susan J.
    Classifications
    LC ClassificationsQA76.165 .G74 1987
    The Physical Object
    Paginationxxiv, 221 p. ;
    Number of Pages221
    ID Numbers
    Open LibraryOL2717786M
    ISBN 100442232284
    LC Control Number86010989


Share this book
You might also like
Pupils work assessed

Pupils work assessed

An Architects guide to building codes & standards.

An Architects guide to building codes & standards.

What happens when learning takes place?.

What happens when learning takes place?.

Dispersed recreation on three forest road systems in Washington and Oregon

Dispersed recreation on three forest road systems in Washington and Oregon

United States courts.

United States courts.

Dictionary of Indian biography. --

Dictionary of Indian biography. --

parallel of the orders of architecture, Greek and Roman

parallel of the orders of architecture, Greek and Roman

Real estate commission and liability

Real estate commission and liability

The complete writings of Thucydides.

The complete writings of Thucydides.

Conflicts of power in modern culture

Conflicts of power in modern culture

kept woman

kept woman

An essay on the impolicy of the African slave trade.

An essay on the impolicy of the African slave trade.

intuitive philosophy

intuitive philosophy

BASIC programming for chemists

BASIC programming for chemists

Making sense of heritability

Making sense of heritability

How to write computer documentation for users by Susan J. Grimm Download PDF EPUB FB2

Genre/Form: Handbooks and manuals Handbooks, manuals, etc: Additional Physical Format: Online version: Grimm, Susan J. How to write computer documentation for users.

Designed to help processing professionals and technical writers write clear, accurate computer user documentation. Presents a systematic approach to writing paper and online documentation.

Version 2 retains much essential material from the first edition, while offering new information on desktop publishing, CASE tools and the ``software factory Cited by: A beginner’s guide to writing documentationyou will start to empathize with your users.

If only I had written down why I had done this. Documentation allows you to transfer the why behind code. Much in the same way code comments explain the why, and not the how, documentation serves the same purpose.

Sidebar on open source. This is not a handbook for such documentation, but instead for user's manuals, maintenance manuals, operator's manuals, etc. Software documentation includes many more forms of documentation (specifications, drawings, etc.) for which this book would be inappropriate.

I found the book's format and contents to be useful and informative. This how-to approach to all forms of computer documentation, including on-line documents with links to related topics and help files that guide even beginning users, has made more sophisticated software accessible to everyone.

The first requirement for task-oriented software documentation is an understanding of the jobs your users perform. Because documentation address the disconnect between users and code, it’s difficult or impossible to write code that will obviate writing documentation.

There is a lot of room for automation in documentation: for the most part the methods for publishing and updating documentation are terrible, which makes keeping documentation up to date even. Writing better computer user documentation: From paper to online Hardcover – by R.

John Brockmann (Author) › Visit Amazon's R. John Brockmann Page. Find all the books, read about the author, and more. See search results for this author. Are you an author. Cited by:   Good software documentation is specific, concise, and relevant, providing all the information important to the person using the software.

Following are instructions on how to write software documentation for technical users and end users%(). Welcome to our community. Write the Docs is a global community of people who care about documentation.

Our primary gathering places are: Our slack network with thousands of members; Conferences on 3 continents; Local meetups in over 40 cities; We consider everyone who cares about communication, documentation, and their users to be a member of our community.