Советы по грамотному написанию технической документации для пользователей.
Часть 3 (заключительная)
Заключение руководства нашего технического писателя Андрея Старовойтова, которое поможет сделать вашу пользовательскую документацию проще и понятнее.
На этот раз мы поподробнее рассмотрим:
- концептуальные топики (concept pages);
- справочные топики (reference pages);
- топики, в которых рассказывается, как решить какую-нибудь проблему (troubleshooting pages);
- где и как использовать скриншоты;
- а также дадим пару советов тем, кто пишет документацию на английском.
Предыдущие части: наш подход к документированию и локализации; советы по документированию часть 1 и часть 2.
Читать полностью »