Pull to refresh

Вредные советы: как правильно писать техническую документацию? Часть вторая

Parallels corporate blog Development Management *Project management *IT-companies Technical Writing *
Советы по грамотному написанию технической документации для пользователей.
Часть 2


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

Начало статьи можно почитать тут, а то, как проходит процесс документирования и локализации наших продуктов мы описывали ранее в этой статье.

В этой части мы подробно разберем топики, из которых в основном состоит пользовательская документация (особенно User’s Guide) – а именно task-топики, в которых рассказывается, как решить конкретную задачу.

image
Читать дальше →
Total votes 13: ↑12 and ↓1 +11
Views 6.1K
Comments 4

Conceptogram as a method to create more effective technical documentation

Иннотех corporate blog Popular science Technical Writing *
Translation

Konstantin Kotelnik, an analyst at Innotech, ponders over making technical documentation easier to understand for developers and helping the clip-thought generation work effectively with large quantities of data. Read the article to find out about the potential emergence of a graphical IT-Esperanto and the standardisation of technical language.

Read more
Total votes 2: ↑2 and ↓0 +2
Views 562
Comments 0