A directory of resources inthe field of technical communication.

Presentations>Documentation>Methods

3 found.

About this Site | Advanced Search | Localization | Site Maps

 

1.
#14541

Document Development: Getting the Technical Writer Involved Up Front   (PDF)

Working in close cooperation with the chief subject-matter expert (SME) for a major group of documents, we changed the document development process. Instead of having a SME write a draft-leaving the technical writer function as secretary, editor, and layIout technician—we involved the writer from the beginning of the project. The result was a cleaner, neater document development process; a better document; and a lot less trouble for all concerned.

Remington, Thomas F. STC Proceedings (1995). Presentations>Documentation>Methods

2.
#14527

Honey, I Shrunk The Manual   (PDF)

The writers at Software Publishing Corporation faced the challenge of reducing the page count of their manuals by more than 50%—without sacrificing quality, extending the schedule, or starting from scratch! They found that approaching this daunting task from several different directions at the same time proved to be the most effective. While the following tips apply primarily to DOS and Windows software manuals, the tips are a good starting point for streamlining any documentation set. The benefits include cutting dollars from the per unit cost of goods and promoting greater customer acceptance of documentation as a learning tool.

Repel, Timothy R. and Jennie Tan. STC Proceedings (1994). Presentations>Documentation>Methods

3.
#14516

Quality Management And Quality Information Products: Developing An Effective Methodology For Quality-Driven User Documentation   (PDF)

Developing a methodology for creating user documentation involves the following phases: analyze need, plan, define requirements, design, construct, test, implement, and maintain. In addition to moving through these phases while creating the methodology, you must include each of these standard phases as a major section in the methodology. This paper describes how the Documentation and Training Center of Excellence used the standard project methodology phases to create and implement a methodology which tied closely to the phases.

Smittle, Linda S. and Robert C. Vestal. STC Proceedings (1994). Presentations>Documentation>Methods

There are 10 readers currently online: 0 registered users and 10 guests. Register.Follow us on: TwitterFacebookRSSPost about us on: TwitterFacebookDeliciousRSSStumbleUpon