Skip to Content Skip to Main Navigation
 

Proper Documentation Assists Users with Mobile Apps 

Image for Documentation for Mobile Apps Post

Mobile applications are a hot topic right now, and that became apparent at the STC Technical Communication Summit in May of 2012. While technical writers are generally the ones behind the scenes, it’s become apparent that in order to use apps on your phone, you need to have some helpful documentation.

Technical writers step in to write the helpful documents that allow users to:

  • Learn how to use the app – From how to get started to how to make the most use of the app, documentation is a helpful resource.
  • Learn how to troubleshoot the app – When bugs pop up, user assistance can help the user investigate issues before having to contact customer support.
  • Learn how to manage the app’s settings – In order to customize the app, the documentation can show how to adjust its various settings.

These different ways of helping can come in the form of a Help menu in the app, instructions as the app unfolds for use, and online documentation that the user of the app can access once they have purchased it.

On the other hand, documentation is also helpful for higher level application users or designers. These pieces of technical writing can help show how the application was created, how it works, and how it can be manipulated and extended to provide different functions.

Many technical writers who are involved in covering the documentation for mobile apps may also be involved in their actual design, functionality, or provide input on usability.

Related topic:

Make Technical Writing Work for Mobile Devices

Be Sociable, Share!

2 Comments

  1. By Raghuramon 22nd, June 2012 at 8:34 am

    With the 3G/4G technologies, the online apps in mobile are gaining popularity. What do you think about documenting such applications.

  2. By Zvi Eynanon 22nd, June 2012 at 9:18 am

    When writing for mobile application consider the size of a mobile screen and the limited time the reader has.
    This type of documentation resembles a quick guide more than a manual

Leave a Reply