메뉴 건너뛰기

XEDITION

등업게시판

The True Story Behind Investasi

StaceyLipsey055294 2025.07.17 14:44 조회 수 : 0

Title:
Writing Helpful Help A Minimalism Checklist


Word Count:
560


Summary:
User documentation is all too often written by programmers for programmers. It tends to focus on the products features, rather than the users tasks. Generally, programmers arent in the ideal position to be writing user documentation. Theyre too close to the bits and bytes, and theyre too far from the user. To them, what the product can do tends to be far more important than what the user can do with the product.



Keywords:
writing checklist, writing for the web



Article Body:
User documentation is all too often written by programmers for programmers. It tends to focus on the products features, rather than the users tasks. Generally, programmers arent in the ideal position to be writing user documentation. Theyre too close to the bits and bytes, and theyre too far from the user. To them, what the product can do tends to be far more important than what the user can do with the product.


Its a subtle but vital distinction. Research shows that the key to effective user documentation is writing task oriented help. Even better, write your help according to the minimalist theory. In the documentation world, minimalism is a fancy word for a commonsense practice. In basic terms, it means write to your reader and keep it simple.


The theory itself has a lot of twists and turns. If you want to read a great but slightly wordy book on the subject, check out the book Minimalism Beyond the Nurnberg Funnel, 1998, edited by John Carroll.


In the meantime, if you can tick every item in the following checklist, youll be well on your way to usable online help that both your readers and your managers will thank you for.


Helpful Help Checklist


  1. Base the help on real tasks (or realistic examples)


  2. Structure the help based on task sequence Chapter headings should be goals and topics should be tasks


  3. Respect the reader's activity this is generally more about what you dont do than what you do. In the event you cherished this article as well as you would like to obtain guidance concerning informasi generously visit our own web-page. Dont waste the readers time by diving off into tangents


  4. Exploit prior knowledge and experience Draw the readers attention to previous tasks, experiences, successes, and failures


  5. Prevent mistakes - "Ensure you do x before doing y"


  6. Detect and identify mistakes - "If this fails, you may have entered the path incorrectly"


  7. Fix mistakes - "Re-enter the path"


  8. Provide error komersial info at end of tasks where necessary (rule of thumb, one error info note per three tasks is a good average)


  9. Don't break up instructions with notes, cautions, warnings, and exceptional cases - Put these things at the end of the instruction, wherever possible


  10. Be brief, don't spell everything out, especially things that can be taken for granted


  11. Omit conceptual and note information where possible, or link to it. Perhaps provide expansion information at the end of the topic, plus maybe a note that there are other ways to perform the task/goal, but this is the easiest


  12. Sections should look short and read short


  13. Provide closure for sections (e.g., back to original screen/goal)


  14. Provide an immediate opportunity to act and encourage exploration and innovation (use active invitations to act, such as, "See for yourself..." or "Try this..." rather than passive invitations such as, "You can...")


  15. Get users started quickly


  16. Allow for reading in any order - make each section modular, especially goals, but perhaps tasks (definitely if they can be performed in different order)


  17. Highlight things that are not typical


  18. Use active voice rather than passive voice


  19. Try to account for the user's environment in your writing


  20. Before writing anything, ask yourself Will this help my reader?


By building these practices into your documentation process, youll find that your online help becomes easier to write, shorter, and far more usable for investasi your reader. Whats more, your boss will love you!
번호 제목 글쓴이 날짜 조회 수
공지 esky에 오신걸 환영합니다. 관리자 2024.12.09 34
9877 Answers About Commercial Jingles EdgardoWrixon9345 2025.07.21 0
9876 Jadi Inilah Alasan Seorang Main-main Judi Online, Banyak Manfaatnya JerrellFell97674293 2025.07.21 0
9875 Tata Cara Bermain Judi Online Domino Supaya Cepat Menang ShaunSales2150812 2025.07.21 0
9874 Inilah 3 Type Games Judi Online Yang Sesuai Dimainkan Oleh Pemula SidneyGoldhar44 2025.07.21 0
9873 Yuk, Kenalan Market Judi Online Bola Dan Bagaimana Cara Membacanya KevinArida24312310 2025.07.21 0
9872 Sustainable Kitchens: 11 Thing You're Forgetting To Do... FrankFitzwater52 2025.07.21 0
9871 11 Creative Ways To Write About Remodel Project Management... NobleHolton8662304 2025.07.21 0
9870 Why We Love Order Cabinets (And You Should, Too!)... GidgetGrant5070713 2025.07.21 0
9869 Mejores Juegos Betsafe JuliusMcknight687401 2025.07.21 0
9868 Criação De Sites Profissional HershelStafford923 2025.07.21 8
9867 Jadi Ini Tipe Game Judi Online Poker, Para Mania Sudah Tahu Bukan? VirginiaStookey15833 2025.07.21 0
9866 Mau Menang Main-main Judi Online Poker? Hindari Kesalahan-kesalahan Ini Dulu! MckinleyClaxton90 2025.07.21 2
9865 Beberapa Ciri Situs Judi Online Domino Yang Aman Dan Terpercaya JorgeAcosta26902943 2025.07.21 0
9864 Desenvolvimento De Sites Modernos ConnieDesrochers 2025.07.21 0
9863 Inilah 7 Jenis Pasaran Games Taruhan Bola Paling Populer MaximoBainton183819 2025.07.21 0
9862 10 Tips For Making A Good Cabinet Expertise Even Better... ElvaBarlee960740629 2025.07.21 0
9861 Judi Online Poker Games Kartu Paling Populer AnastasiaNru3244 2025.07.21 0
9860 Is Tech Making Cabinet Innovation Better Or Worse?... GracielaX3803477079 2025.07.21 0
9859 12 Do's And Don'ts For A Successful Quality Craftsmanship... VernaTreasure8839379 2025.07.21 0
9858 188BET – Thiên Đường Cá Cược Trực Tuyến JoseConley9583204 2025.07.21 0
위로