Giới Thiệu · Technical Documentation Copy and Paste Kit
No, this kit will not write your next user manual or your next online help system for you. However, this kit will help you to write your technical documentation with less effort, and it will help you to produce user-friendly, high-quality documents. The kit provides you with exactly those things that your text editor, help authoring tool, or content management system doesn't provide: the know-how and guidance to create high-quality user assistance. However, unlike many textbooks on technical writing, the kit doesn't give lengthy theoretical elaborations. It gives practical recommendations and examples that you can easily remember and adapt to your own work.The kit covers: * the visual design (the layout) of your documents * the structure of your documents * how to write plain instructions that every user understands
You don't have to be a designer to implement the design recommendations, and you don't have to be a linguist to understand the writing rules. All recommendations come with catchy examples. The kit is written in plain, simple English that you can easily understand even if you speak English as a second language. Almost all rules are universal, so you can also use the kit if you write in languages other than English. In the Plus Edition of the kit, you and your team can add your own company-specific conventions and regulations. Getting a professional yet custom interactive writing style guide has never been easier. You are free to control who can edit the rules: just you, only selected team members, or everybody.
