| The must-have reference for every technical writer, editor, and documentation manager--"now fully updated! "Read Me First! is the definitive guide to creating technical documentation that is clear, consistent, and easy to understand. Sun Microsystems' award-winning technical writers and editors cover everything from grammar to clarity, illustrations to workflow. This fully revised second edition reflects dramatic changes in the production and delivery of technical documentation. Coverage includes: Detailed grammar, punctuation, typographic, and legal guidelinesExtensive guidance on creating effective step-by-step proceduresTechniques for documenting Web applications and graphical user interfacesExpert help with creating indexes and glossariesExtensive recommendations for using hyperlinksChecklists and forms for editing, tracking manuscripts, and verifying production statusGuidelines for using commonly confused words and termsPractical tips for gender-neutral writingInternationalization guidelines that simplify translation and improve clarity for non-native English speakersReal-world help for managers: hiring writers, working with illustrators, managing schedules and workflow, coordinating with printers, and moreExpanded and updated recommended reading list
|