7 правил написания технической документации мирового класса

Внедрение

Сочинение технической документации — тяжелое дело. Прочтение слабо написанного технологического документа считается более тяжелым и, возможно, более слабым занятием, чем его сочинение. Нужно огромная работа, чтобы сделать четкое, четкое, любопытное технологическое описание. Вследствие этого, чтобы сделать жизнь хоть несколько легче для всех участвующих сторон, мне хотелось бы поделиться с вами семью требованиями, которым я следую, формируя технологическую документацию.

Эти требования — не мое свое открытие. Скорее всего, я просто определил их из того опыта, который был замечен благодаря общению со многими профессиональными технологическими и писательскими редакторами за более чем двадцать лет работы. Все, что я осознал в данном деле, сложилось потому, что иные продемонстрировали мне маршрут. У меня не располагается довольно слов, чтобы высказать им полностью свою признательность.

Рассчитываю, после чтения данной публикации в вашем запасе будут определенные свежие приборы, которые помогут вам формировать технологические бумаги на новом уровне качества: более четкие, более интересные, менее путанные и значительно более любопытные для чтения. Также я добавил — без любых каких-нибудь особых условий к вам, как покупателю, приз в середине публикации: описание процесса, применяемого мной для образования технологического изображения.

Так вот — эти 7 требований:
Тоска уничтожает
До того как начать, выясните в точности для себя, какие действия вы ждете от пользователя, осилившего ваш труд
Пишите в соответствии с верно выработанной текстурой
Опасайтесь неопределенных местоимений
Четкость = картинке + слова
Когда имеете дело с мнениями, концепциями и т.п., применяйте закономерную картинку и образец
Не бойтесь переделок

1. Тоска уничтожает

Это требование считается, по-видимому, самым тяжелым для формализации и важнейшим по потребности соблюдения. В сегодняшнем мире сети-интернет работает масса усилий, дерущихся за внимание вашего пользователя. Неинтересное обычное описание работать не будет. При любых жизненных обстоятельствах ваш читатель хочет, чтобы было интересно и информативно. Вследствие этого, в случае если ваш документ смутный либо скучный, то читатель просто щелкнет несчастную клавишу «Далее» и перейдет на другую интернет-страницу либо на другую ТВ-программу либо на собственную страничку в Facebook.

Самый простой маршрут, который я обнаружил для просыпания внимания у пользователя, заключается в том, чтобы любопытно было мне самому. Я всегда прилагаю существенные действия, чтобы напечатать такую публикацию, которую сам хотел почитать. Я рвусь наслаждаться от того, что пишу. В случае если мне скучновато, то заскучает и читатель. В случае если я потерялся, то запутается и читатель. В случае если меня не тревожит оцениваемая тематика, то читатель, особенно, не встревожится. Все просто!

Мне нравится юмор, вследствие этого я пытаюсь сделать мои писательские технологические «творения» интересными, однако, разумеется, без вреда для безоблачности. Стараюсь общаться с читателем, а не учить его. Пишу о делах, которые, на самом деле, имеют значение для меня. Обширно применяю картинке, чтобы предупредить неопределенность для пользователя.

И вновь, всегда пытаюсь сделать процесс чтения интересным. Я всегда вспоминаю, что пишу в состязательной среде. Присутствует большое количество текста, старающегося завлечь внимание читателей. Так что, мой совет по требованию номер 1: в случае если ваши слова будут увлекательны вам, то они будет любопытными и для пользователя.

Оставить комментарий

Ваш e-mail не будет опубликован. Обязательные поля помечены *