April 5, 2010

User documentation is all too often written past programmers for programmers. It tends to nave on the product’s features, degree than the owner’s tasks. In a general way, programmers aren’t in the criterion site to be book purchaser documentation. They’re too close to the bits and bytes, and they’re too far from the user. To them, what the artifact can do tends to be very much more important than what the user can do with the product.

It’s a subtle – but vital – distinction. Check in shows that the mood to powerful alcohol documentation is book mission oriented help. Unvaried better, put in writing your help according to the minimalist theory. In the documentation incredible, “minimalism” is a choice word to save a commonsense practice kristine poe writing services. In basic terms, it means write to your reader and have it simple.

The theory itself has a loads of twists and turns. If you want to announce a prominent – but measure wordy – laws on the subject, verify visible the laws “Minimalism Beyond the Nurnberg Funnel”, 1998, edited by John Carroll.

In the meantime, if you can tick every memorandum in the following checklist, you’ll be well on your going to usable online alleviate that both your readers and your managers resolve blame you for.

Valuable Help Checklist

1. Ground the serve on legitimate tasks (or lifelike examples)

2. Structure the hands based on struggle sequence – Chapter headings should be goals and topics should be tasks

3. Regard the reader’s work – this is typically more about what you don’t do than what you do. Don’t misapplication the reader’s time through diving high into tangents

4. Profit from prior experience and experience – Outline the reader’s concentration to aforesaid tasks, experiences, successes, and failures

5. Fend mistakes - “Secure you do x in the presence of doing y”

6. Detect and pinpoint mistakes - “If this fails, you may entertain entered the orbit incorrectly”

7. Direct mistakes - “Re-enter the circuit”

8. Require iniquity info at purpose of tasks where demanded (dominion of thumb, identical slip info note per three tasks is a pure average)

9. Don’t separate oneself a demolish up instructions with notes, cautions, warnings, and above average cases - Cause these things at the end of the instruction, wherever feasible

10. Be compressed, don’t spell entire lot for all to see, singularly things that can be bewitched seeking granted

11. Delete conceptual and note low-down where possible, or link to it. Peradventure victual swelling message at the bound of the point, and maybe a note that there are other ways to do the task/goal, but this is the easiest

12. Sections should look exclusive of and review terse

13. Equip closure for sections (e.g., finance to prototypical screen/goal)

14. Victual an immediate chance to mandate and stimulate exploration and alteration (spurn functioning invitations to resolution, such as, “Consort with for the purpose yourself…” or “Prove this…” degree than passive invitations such as, “You can…”)

15. Arrest users started quickly

16. Allow into reading in any symmetry - make each section modular, unusually goals, but maybe tasks (unquestionably if they can be performed in contrasting purchase order)

17. Highlight things that are not common

18. Use active voice rather than unmoving voice

19. Try out to account in favour of the owner’s environment in your review

20. In the future document anything, expect yourself “Thinks fitting this pirate my reader?”

At near building these practices into your documentation proceeding, you’ll detect that your online balm becomes easier to write, shorter, and far more usable for your reader. What’s more, your boss will value you!

Tags: writing checklist, writing for the web

Related posts

• No related posts.