Writing and book indexing help for desktop publishers. Often desktop publishers become jack-of-all-trades and need at least a basic understanding of technical writing.
For technical writers, an overview of the components of a technical guide, users manual, or other similiar book.
Not every one of these parts would be found in technical manuals or user guides, but many of them are standard parts of any book. The technical writer may be responsible for more than just the body of the book.
Eliminate excess space in lists using these techniques involving tabs, alignment, and leader dots.
Technical writing often makes extensive use of bullet lists. There is no automated bullet list function in QuarkXPress 4; however, you can use style sheets to create quick, basic lists with simple bullets.
Use bullets to organize a list or draw attention to information. Here are some design considerations for using bullet lists.
There's an art to writing a dictionary entry. Learn how to compose definitions.
Illustrated tutorial takes you step by step through index creation with FrameMaker.
From the American Society of Indexers, the types of tools and utilities used for indexing along with sources.
American Society of Indexers answers questions about what indexing involves, computer indexing, and skills needed.
A crash course in how to write an index from an online textbook on technical writing.
When writing instructions on how to assemble something, use an item, or do a specific task there are some common steps and formats to consider as described in great detail here.
PRC describes the users of technical documentation and the types of manuals along with problems associated with user manuals.
PRC has tips for writing user-friendly manuals aimed at consumers and unskilled workers.
From Online Technical Writing, what needs to go in and how to write organizational policies and procedures.
From your Desktop Publishing Guide, setting dot leaders in various programs, for indexes, lists, and table of contents.
This writing advice is aimed at those writing research papers in computer science and electrical engineering.
Usernomics provides a long list of resources for style guides and other resources for use in writing manuals, online help, and other technical documentation.
An overview of technical reports and what goes in them, from the online textbook for technical writing.
Nancy Halligan provides a short course in technical writing of reports.
Need to write a manual, help file, or instruction booklet? This online textbook covers applications of technical writing, document design, and the process of technical writing.
Preferred software, working with printshops, and more information for creating manuals and other technical documents, from PRC.
In this online tutorial learn the components and conventions of user guides.
Components of and tips for writing user guides. Covers what to include, examples, and the process of putting together a user guide.
The Owl at Purdue describes the purpose and audience of a white paper and provides tips on organizing and writing white papers.
Do you use "Plain Language" in your technical writing? This series of articles include how to write clearly, engage your audience, organize your material, and avoid confusion.
