Technical Writing, User Assistance, Information Design
Links for technical writers and others who create technical documentation and software documentation: technical writing, user assistance (UA), technical communication, technical documentation, information design
On this page:
Online magazine for international information development.
TechWhirl Tech Writer Today Online Magazine
Online articles and resources for technical writers and technical communicators.
Provides a collection of excellent presentation slides with a focus on software user assistance.
Dozuki Tech Writing Handbook
Brief online handbook on the essentials of technical writing. Nicely designed but very not very comprehensive.
Online Technical Writing
Basic online textbook on technical writing.
Web Writing That Works
If you browse a little you can find some good tips here.
Provides a basic online course in technical writing.
Indexing user manuals
The British/Irish Society of Indexers provides a number of articles on indexing user manuals (go to “Advice for authors > Advice to technical authors”). There’s also a corresponding usability study available (go to “About indexing > Usability of indexes”).
Windows User Experience Interaction Guidelines
Comprehensive guidelines published by Microsoft.
The Usability Methods Toolbox
Brief explanations of the most common methods used in usability testing.
Usability basics, methods, templates, guidelines and other resources, provided by U.S. Department of Health & Human Services.
UI Style Guides
Collection of links to a number of user interface style guides.
ACM SIGCHI is the special interest group on Computer-Human Interaction of the Association for Computing Machinery (ACM). They provide a very comprehensive link collection as well as a bibliography database with more than 50000 listed publications.
News and links to hundreds of articles and resources on information design.
A List Apart
Hundreds of comprehensive articles, mainly on web design and web technology.
Online magazine for international information management.
Boxes and Arrows
Lots of interesting articles on design, including graphic design, interaction design and information architecture.
User Interface Engineering
Provides a large collection of excellent, detailed articles.
Following its motto “Insights and inspiration for the user experience community,” UXmatters provides a wealth of excellent articles on user experience and user assistance.
Articles of the Nielsen Norman Group
Frequently published articles on web usability. For good reasons this probably is the most frequently linked and cited web site in its field.
Don Norman jnd we bsite
Dozens of great essays on product design. The section labeled “In Praise of Good Design” illustrates products that have some special positive characteristic worthy of comment.
Collection of comprehensive articles on usability and user experience.
International Organization for Standardization (ISO)
Here you can purchase copies of international standards.
Free information and downloads on European law, including the Machinery Directive. Provided by the European Union.
The official web site for the JavaHelp system.
Oracle Help Technologies
Oracle’s web site on Oracle Help for Java and Oracle Help for the web.
Docs Like Code
Collection of info on the docs-as-code approach of documentation development.
Popular forums and comprehensive wiki on ebooks.
Web site dedicated to Microsoft Help.
The official community and resource for the DITA OASIS standard.
Fluid Topics DITA publications
DITA specification in webhelp format.
Free online learning courses on the basics of DITA.
Collection of DITA-related information and links.
Various DITA-related articles and links.
Originally intended for writing technical documents related to computer hardware and software, but can also be used for other sorts of documentation.
Information model for plant construction and mechanical engineering (and others).
Some less well-known or emerging standards and initiatives are:
I’d Rather Be Writing
“A blog about the latest trends in technical communication” by Tom Johnson.
Cherryleaf Technical Authors Blog
Blog on a wide spectrum of topics related to user assistance.
Blog on technical communication in general but with a focus on technology-related topics.
Every Page is Page One
“Readers can enter anywhere. Is your content ready to receive them?” by Mark Baker.
“Official newsletter and blog of CyberText Consulting: Technical communication specialists.”
Blog run by tekom with posts from various authors, both in English and in German.
“A technical writer’s blog” by Sarah Maddox.
“Examining documentation and help systems since 2002” by Gordon Meyer.
The Techwriting Engineer
Blog by Mattias Sander with a focus on MadCap Flare, Lean Management, and Kaizen.
The Content Wrangler
“Content is a business asset worthy of being managed” by Scott Abel.
Technical Communication Center
“Technical Writing & Communication Tips, Trends & Tutorials” by Ugur Akinci.
The m-Learning Revolution Blog
Blog by by RJ Jacquez.
I Came, I Saw, I Learned …
“The place to share resources, ideas, and general information about Adobe’s Technical Communication Suite applications: RoboHelp, FrameMaker, Captivate, Acrobat, and PhotoShop.” Blog by IconLogic, Inc.
TechComm Central by Adobe
Blog by Adobe staff and some guest bloggers.
Docu + Design Daube
Various FrameMaker resources.
Various tips on Captivate, CSS, Flare, HTML, dynamic help, and web-based help.
HELP ESSENTIALS blog
Blog concentrating on Adobe RoboHelp.
Did you benefit from this guide? Did it save you some time compared to search via Google or other search engines? Please help me to keep the guide free and up to date also in the future. Buy a copy of the PDF version (approx. 120 pages).
This page was last updated 01/2020