Клуб технических писателей

Помогите начать!)

Евгения Сидорова
23 апреля 2015, 09:54

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

4 комментария
Подписаться на комментарии к посту

В прошлом году мы публиковали список литературы по вопросам, связанным с техническим писательством. С ним можно ознакомиться по ссылке: http://clubs.ya.ru/x-plain/replies.xml?item_no=27

Наши писатели подготовили обзоры на некоторые из перечисленных книг:

Technical Writing 101

Слово живое и мертвое

Посты Алексея с тегом стиль частично основаны на сведениях, содержащихся в книге "Style: Lessons in Clarity and Grace".

Виктор Фигурнов
23 апреля 2015, 14:01

Я бы еще добавил книжки:

Мильчин А., Чельцова Л. Справочник издателя и автора, 4-е изд. Изд. Студии Артемия Лебедева, 2014. - 1010 с.

Глаголев В.А. Разработка технической документации. Руководство для технических писателей и локализаторов ПО. - СПб.: Питер, 2008. - 192 с.

Гримм С. Дж. Как писать руководства для пользователей ЭВМ: Пер. с англ. - М.: Радио и связь, 1985. - 160 с.

Липаев В.В. Документирование сложных программных средств. – М.: СИНТЕГ, 2005. - 124 с.

Van Laan K. The Insider’s Guide to Technical Writing. - XML Press, 2012, - 346 pp.

 

И стандарты:

ISO/IEC Std 26514:2008. Systems and software engineering — Requirements for designers and developers of user documentation

ISO/IEC/IEEE Std 26511:2011. Systems and software engineering — Requirements for managers of user documentation

ISO/IEC/IEEE Std 26515:2011. Systems and software engineering — Developing user documentation in an agile environment

IEEE Std 1063-2001. IEEE Standard for Software User Documentation

IEEE Std 829-2008. IEEE Standard for Software and System Test Documentation

IEEE Std 830-1998. IEEE Recommended Practice for Software Requirements Specifications


И надо хорошо разбираться в той предметной области, в которой вы работаете или хотите работать. Без этого что-то толковое и грамотное написать трудно.

Евгения, скажите, а какие у вас "входные параметры"? :-) Для каких типов программных продуктов вы пишете документацию, кто ваши пользователи, какие используются технологии и инструменты? Какой язык - русский или английский?

 

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

Много хорошо структурированной информации есть на сайте Философт http://www.philosoft.ru.