Technical Writing for Desktop Publishers
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.
Book Design Overview
For technical writers, an overview of the components of a technical guide, users manual, or other similiar book.
For technical writers, an overview of the components of a technical guide, users manual, or other similiar book.
Book Parts
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.
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.
Bullet and Numbered Lists
Eliminate excess space in lists using these techniques involving tabs, alignment, and leader dots.
Eliminate excess space in lists using these techniques involving tabs, alignment, and leader dots.
Bullet Lists - QuarkXPress
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.
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.
Bullet Lists
Use bullets to organize a list or draw attention to information. Here are some design considerations for using bullet lists.
Use bullets to organize a list or draw attention to information. Here are some design considerations for using bullet lists.
Dictionary Definitions
There's an art to writing a dictionary entry. Learn how to compose definitions.
There's an art to writing a dictionary entry. Learn how to compose definitions.
Index - FrameMaker
Illustrated tutorial takes you step by step through index creation with FrameMaker.
Illustrated tutorial takes you step by step through index creation with FrameMaker.
Indexing Software
From the American Society of Indexers, the types of tools and utilities used for indexing along with sources.
From the American Society of Indexers, the types of tools and utilities used for indexing along with sources.
Indexing
American Society of Indexers answers questions about what indexing involves, computer indexing, and skills needed.
American Society of Indexers answers questions about what indexing involves, computer indexing, and skills needed.
Indexing
A crash course in how to write an index from an online textbook on technical writing.
A crash course in how to write an index from an online textbook on technical writing.
Instructions
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.
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.
Manuals
PRC describes the users of technical documentation and the types of manuals along with problems associated with user manuals.
PRC describes the users of technical documentation and the types of manuals along with problems associated with user manuals.
Manuals
PRC has tips for writing user-friendly manuals aimed at consumers and unskilled workers.
PRC has tips for writing user-friendly manuals aimed at consumers and unskilled workers.
Organizational Policies and Procedures
From Online Technical Writing, what needs to go in and how to write organizational policies and procedures.
From Online Technical Writing, what needs to go in and how to write organizational policies and procedures.
Tab or Dot Leaders
From your Desktop Publishing Guide, setting dot leaders in various programs, for indexes, lists, and table of contents.
From your Desktop Publishing Guide, setting dot leaders in various programs, for indexes, lists, and table of contents.
Technical Articles
This writing advice is aimed at those writing research papers in computer science and electrical engineering.
This writing advice is aimed at those writing research papers in computer science and electrical engineering.
Technical Documentation
Usernomics provides a long list of resources for style guides and other resources for use in writing manuals, online help, and other technical documentation.
Usernomics provides a long list of resources for style guides and other resources for use in writing manuals, online help, and other technical documentation.
Technical Reports
An overview of technical reports and what goes in them, from the online textbook for technical writing.
An overview of technical reports and what goes in them, from the online textbook for technical writing.
Technical Reports
Nancy Halligan provides a short course in technical writing of reports.
Nancy Halligan provides a short course in technical writing of reports.
Technical Writing Online Textbook
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.
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.
Technical Writing Trends
Preferred software, working with printshops, and more information for creating manuals and other technical documents, from PRC.
Preferred software, working with printshops, and more information for creating manuals and other technical documents, from PRC.
User Guides
In this online tutorial learn the components and conventions of user guides.
In this online tutorial learn the components and conventions of user guides.
User Guides
Components of and tips for writing user guides. Covers what to include, examples, and the process of putting together a user guide.
Components of and tips for writing user guides. Covers what to include, examples, and the process of putting together a user guide.
White Papers
The Owl at Purdue describes the purpose and audience of a white paper and provides tips on organizing and writing white papers.
The Owl at Purdue describes the purpose and audience of a white paper and provides tips on organizing and writing white papers.
Writing User-Friendly Documents
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.
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.