Home Library Translate
A A A
Share »
Follow us on Facebook Follow us on Twitter Follow us on LinkedIn
Connect »

Blog: Business Communications

Menu

  • This Blog's Home
  • Guest Writer Submissions
  • Policies
  • To Subscribe to a Blog
  • About
  • Feedback

13 Tips For Technical Writers

By Theresa Pojuner on January 9, 2012

I’ve come up with the following tips to follow when creating a document. You can think of it as a checklist. Hope you find it helpful.

  • Know your SME (Subject Matter Expert) – find them and collaborate; create relationships and work with them and inform them of why you’re there; use any opportunity to gather information. Help them help you-assist them by preparing questions and information that you already know and find out what is relevant. Ask what (is the product or its features, etc.), why (is it done this way, was it created, etc.), where (does this take place or belong, etc.), when (does or did this occur, etc.), how (is a process or procedure done, etc.) and who (is affected or is involved, etc.).
  • Know your target audience and their preferences – share and connect; find out what they want and need and in what format, be it video, print matter, charts, or training sessions. Show examples of previous documents to find out what they prefer.
  • Make sure your stakeholders are all in sync before any material is created; else you will be rewriting and rewriting.
  • Be concise and get to the point, make it simple – less verbiage, No more than 5 sentences per paragraph; use outlines, create quick reference guides and style guides for easy referral.
  • Use illustrations, tables, charts, graphics, print screens – let the image do the describing and make sure you note any exceptions to any process. Use icons, bullets, numbers and alphabetize – make it visually appealing and be organized and helpful by separating out data or material.
  • More white space – have plenty of white space- great for notes and readability.
  • Check your grammar and spelling – get the words right; correct and simple and know your terminology.
  • Know your timeline, workload, and prioritize – don’t be late; be organized and ready. Know your goals and schedule deliverables accordingly.
  • Get it verified and authorized – make it good to go.
  • Create your style guide and check list – list necessities or requirements, and maintain consistency and standardization.
  • Listen and learn, be open – be knowledgeable and collaborate.
  • Your words are your voice – be a trainer through written material. You are the editor, illustrator, and designer of your information. But most importantly, you translate information in a clear and easy to understand language to your target audience.
  • You are the knowledge manager – the gatekeeper; make sure you track and organize your documents.

If you have other tips to share, please leave a comment.

« Previous Next »

Search Our Site

Meet This Blog’s Host

Gail Zack Anderson, President of Applause, Inc., has nearly 20 years experience in training and coaching. She provides individual presentation coaching, and leads effective presentation workshops and effective trainer workshops. [Read more ...]


Theresa Pojuner is a Documentation Specialist with over 20 years of writing experience and is skilled in many areas of documentation, for example, Style Guides, Training Manuals and Test Cases, wth a specialty n Technical Writing and Procedures. [Read more ...]

Recent Blog Posts
Alternate Recent Posts Widget

  • Becoming A Technical Writer-Communicator Review
  • Creating A Knowledge Community
  • Tips for Handling Technical Writer Stress
  • Likeminded Communication
  • A Technical Writer Is Different From Other Writers
  • Involve and Engage Your Audience 20 Ways
  • Tips On Documenting Processes
  • Communicating Technical Writing Review
  • Communicating Via Visual Designs
  • Special Tips for Laptop Presentations

Related Library Topics

  • Body Language
  • Netiquette

Categories of Posts

  • Basics and Overviews
  • Body Language
  • Communicating Change
  • Communication Best Practices
  • Feedback (Sharing)
  • Humor in speaking
  • images
  • Listening
  • Netiquette
  • Presenting
  • slide shows
  • Speaking Skills
  • Team Presentations
  • technical writing
  • Telephone Skills
  • Uncategorized
  • Visual Aids
  • Voice and Vocal Habits
  • Writing

Library's Blogs

  • Boards of Directors
  • Building a Business
  • Business Communications
  • Business Ethics, Culture and Performance
  • Business Planning
  • Career Management
  • Coaching and Action Learning
  • Consulting and Organizational Development
  • Crisis Management
  • Customer Service
  • Facilitation
  • Free Management Library Blogs
  • Fundraising for Nonprofits
  • Human Resources
  • Leadership
  • Marketing and Social Media
  • Nonprofit Capacity Building
  • Project Management
  • Quality Management
  • Social Enterprise
  • Spirituality
  • Strategic Planning
  • Supervision
  • Team Building and Performance
  • Training and Development
About Feedback Legal Privacy Policy Contact Us
Free Management Library, © Copyright Authenticity Consulting, LLC ®; All rights reserved.
  • Graphics by Wylde Hare LLC
  • Website maintained by Caitlin Cahill

By continuing to use this site, you agree to our Privacy Policy.X