Написание документации, где заказать?

Question

[Вадим]

Здравствуйте

Нужно написать документацию (пользовательскую инструкцию) для CMS, где можно найти такого специалиста и как он называется?

Спасибо

Comments

[Saboteur]

technical writer, часто по-совместительству QA

Answer 1

[Игорь]

Зависит от продукта. Технический писатель, но хорошо бы если бы UX эксперт/продукт менеджер писал.

Answer 2

[Эдуард Тибет]

Попробуйте написать сюда: https://vk.com/club_techwriters

Но сразу скажите, что у вас разовый заказ и четко сформулируйте требования.

Answer 3

[Александр Керзаков]

Часто при составлении технической документации используются автоматизированные средства — генераторы документации, такие как Doxygen, javadoc, NDoc и другие. Они получают информацию из специальным образом оформленных комментариев в исходном коде, и создают справочные руководства в каком-либо формате, например, в виде текста или HTML.
Использование генераторов документации и документирующих комментариев многими программистами признаётся удобным средством, по различным причинам. В частности, при таком подходе документация является частью исходного кода, и одни и те же инструменты могут использоваться для сборки программы и одновременной сборки документации к ней. Это также упрощает поддержку документации в актуальном состоянии.

WikiPedia

А вообще документацию обычно пишут разработчики, не?

Comments

[Игорь]

Пользовательскую инструкцию пишут не программисты

[Александр Керзаков]

Игорь: интересно, интересно. Буду знать.
Я всегда думал что её проще всего разработчику написать.

[Игорь]

Александр Керзаков: разработчик будет писать с точки зрения разработчика. А надо - с точки зрения клиента/пользователя. Разработчики как правило их вообще не понимают, на разных языках говорят.

[Александр Керзаков]

Игорь: так то оно так, но разработчику вроде как легче понять свой код, алгоритм действия своего продукта.
А техническому писателю, как понять то, что как и к чему, без документации?

[Игорь]

Александр Керзаков: Ну это же пользовательская документация, код тут ни при чём. Приложение рассматривается как чёрный ящик. Технический писатель либо берёт ТЗ, либо спрашивает разработчика и потом пишет понятное обычному пользователю руководство.
Писать грамотные и понятные тексты - это отдельный скил, программисты как правило им не владеют. К тому же у них глаз замылен уже, чтобы понятно свой продукт описать.

[Александр Керзаков]

Игорь: вай, наконец то я понял что в обязанность технического писателя не входит копание в коде.

[Александр Керзаков]

Игорь: спасибо.

[Игорь]

Александр Керзаков: Нет, не входит. Пожалуйста.
Возможно где-то такие случаи и есть (рабочие обязанности - не догма, в каждой организации свои), но мне сложно это представить и я ни разу с таким не сталкивался и о таком не слышал.

[Вадим]

Игорь: Да, самому сложно написать, т.к и так все кажется понятным...)
Можете кого либо порекомендовать?

[Saboteur]

Александр Керзаков: Разработчику обычно нужно писать код, тестировшику тестировать продукт, документацию пишет Technical Writer, потому что кроме самого текста, ее нужно оформить, что занимает приличное время.
Часто Technical Writer совмещает в себе QA или BA, но все зависит от проекта.

[Игорь]

Вадим: к сожалению порекомендовать никого не могу