Npr Instruction Manual Web Base User Written

Posted : admin On 12/19/2021

Sep 27, 2010  Best software for writing HTML-based user manuals closed. The software is written in PHP, so whomever is using it will have a web browser open and ready to go. This also leads to the possibility of me, or someone else, integrating the manual's pages into the software itself.

  1. User Instruction Manual Template
  2. Npr Instruction Manual Web Based User Written Free
  3. Free User Guides & Manuals
  4. Npr Instruction Manual Web Based User Written Video
  5. Npr Instruction Manual Web Based User Written Form
  6. Web-based Result

In a previous article, I went over 14 examples of documentation mistakes you might be making. Today, I'm going to show you 10 examples of what makes great end user documentation.

User Instruction Manual Template

I should clarify that end user documentation does not serve the same purpose as technical documentation, so you shouldn't write them the same way. Technical documentation is meant to teach somebody everything there is to know about a subject, whereas end user documentation is meant to just show somebody the necessary steps to accomplish a task and answer 'How to...' questions.

Npr Instruction Manual Web Base User Written

This document, the User Manual, describes how to use ZCP from a user's view point. It discusses:. Outlook integration by using the Zarafa Windows Client,. using the web-interface of the Zarafa WebAccess,. connectivity with CalDAV and iCal enabled clients,. Have a look at the manual HP LaserJet 4250 User Manual online for free. It’s possible to download the document as PDF or print. offer 1114 HP manuals and user’s guides for free.

Sep 27, 2010 Best software for writing HTML-based user manuals closed. The software is written in PHP, so whomever is using it will have a web browser open and ready to go. Web based instruction (WBI): Custom tailored training delivered through a web browser over any network (Internet, intranet, LAN, etc.). Unlike computer based training (CBT) which is fixed in its format and content, WBI is regularly updated and is available on-demand in several formats. Also called online courseware, online distance education.

The examples I show are examples of what makes great end user documentation.

1 - Write great titles

Great end user documentation consists of titles that are specific, and often in the form of performing a task. This not only makes it easier for your end users to find what they are looking for, but it helps you write better articles.

For example, think about how much time it would take to write an article titled 'Contacts' - you wouldn't know where to start. So you create an outline of all the 'Contacts' topics you can think of, take screenshots of the Contacts object, explain all of the menu options, and write a history of the Contacts object - all useless to an end user who just wants to know how to create a partner contact in Salesforce. Instead of going right to the information they need, end users will have to sift through all of the other stuff to find an answer.

If each article has its own, great title, then your end users can quickly answer their own questions by performing a keyword search or by browsing through your table of contents.

HubSpot does a great job writing useful titles, and then demonstrating the workflow using pictures, text, and annotations. Their documentation is a great example of how to write end user/customer documentation.

Tip for writing great titles

Free user guides & manuals

To continue the example from above, instead of writing one big article titled 'Contacts' just write a dozen little articles that each answer one specific question:

  1. What is a contact?
  2. How do we use contacts?
  3. How to create customer contacts
  4. How to convert a lead into a contact
  5. How to create partner contacts
  6. How to create an account for a contact
  7. How to merge duplicate contacts
  8. How to import contacts from Outlook
  9. How to import contacts from a CSV file
  10. How to add contacts from Gmail using Cirrus
  11. How to change the Contacts view
  12. How to log a call with a contact

These are so much easier to write, and your end users will find them much more useful because they can quickly search for, and find, answers to their specific questions (end users need specifics). Plus, you can always combine a lot of little articles into a larger workflow and organize them into a chapter or a manual.

2 - Use annotated screenshots

The majority of end user documentation should have screenshots, and those screenshots should include some sort of annotation. Adding an arrow, a circle, or number sequences can make end user documentation completely dummy proof, and save end users from having to figure out what to do.

Even if it seems obvious to you where to click, including a few simple annotations will go a long way in removing confusion.

3 - Use video AND screenshots AND text

If you have the budget, the patience, and the time, you can do what Wistia does - create a video explanation, then include step-by-step instructions underneath the video.

This is a great way to do end user documentation. The video acts as a teacher to explain an overall process and provide some initial training. But after the initial training, end users don't need to watch the entire video again - they just need a quick reminder of what to do. The step-by-step instructions are great for the quick reminder.

Npr Instruction Manual Web Based User Written Free

4 - Include links to related articles

When you reference another action, product, workflow, or term, it always helps to include a link to the related article. Otherwise, end users waste time searching for what you just referenced.

5 - Easy to browse

if you only have 10-20 articles, then you don't really need to make them easy to browse. It's when you have over 20 or 30 articles that you really want to make a nice Table of Contents - especially if your documentation is online.

When your end users don't quite know what to search for, they can browse your documentation to find an answer. In this example, Metric Insights has organized their manuals into sections, and then each manual is broken up into chapters and articles.

6 - Easy to search

Google has spoiled everybody. When your end users know what they are looking for, they expect to be able to type in a keyword and find an answer. If your documentation isn't searchable, then it's not going to be used very often.

7 - Easy to find

Below is an example of the ScreenSteps integration with Salesforce. It provides links to articles based on which Salesforce tab is open so end users don't have to go very far to find relevant documentation. Plus, it has a keyword search feature so end users can type in their question and search your ScreenSteps documentation for an answer.

The faster end users can answer their own questions, the less time you'll have to spend answering them yourself or showing them where the answers are.

Free User Guides & Manuals

8 - Show the end result

At the end of it all, what is the end user supposed to see? Here, Skuid does a nice job including a screenshot of the end result with a brief explanation to help end users determine whether everything was done correctly.

9 - Show the steps and substeps

Including step numbers makes it easy for end users to follow along and piece together what they are doing. You can also take advantage of sub-steps to make your documentation easier to follow.

10 - Unique URLs for each article

If you were to click on this URL - you would be taken to the exact article you need to answer your question about how to create a campaign target list. This makes it really easy for you to respond to questions with links to your documentation. Otherwise, you have to say, 'Download this PDF, go to page 47, and on the 3rd paragraph you'll find an answer.'

With a unique URL, you can respond in Chatter, email, in the communities, etc. sending your end users to the exact answer they are looking for.

Npr Instruction Manual Web Based User Written Video

Why do any of this?

The goal of your end user documentation is to reduce the number of hours you spend explaining workflows, and reduce the number of hours end users spend looking for answers.

Npr Instruction Manual Web Based User Written Form

If you can remove hurdles your end users have to jump over in order to find answers, they will reference your documentation. And that will create self-sufficient end users who do the job correctly, in less time, and without constantly involving you.

Web-based Result

Note: HubSpot, Metric Insights, and Skuid all use ScreenSteps to write great end user documentation.