Спасибо за увлекательный и полезный материал. Особо ценным считаю, что Вы не просто поделились своим подходом и инструментарием, но и указали, какие сложности у Вас возникли в процессе. Массив работы в рамках подготовки документа впечатляет.
НЕ согласна с комментарием о том, что 105 часов на 24 страницы — это на грани разумного. Во-первых, в данном случае речь идет о целом проекте по разработке документа, так как объединяет разноплановую работу: аналитику, подготовку текста, выработку структуры, дизайн, верстку, редактирование. Можно за 105 часов написать 100 страниц, только какой в этом смысл, если пользователь в них просто потеряется из-за воды, плохой структуры, неясных и расплывчатых формулировок.
Мне понравилось, что Вы делаете акценты на актуальных и наболевших вопросах для технического писателя. Одним из таких для меня оказался вопрос о том, какую дополнительную информацию включать в руководство пользователя, а какую нет. Понравился ваш подход и отработка замечаний от пользователей по этой теме. Возьму на вооружение.
Только вот боюсь, Adobe InDesign для неопытного пользователя может оказаться сложноватым и потребует дополнительных сил и времени на начальных этапах использования. Но внешний вид документа от его использования определенно выигрывает. А внешний вид также влияет на читабельность, легкость использования и на пользовательское впечатление об описываемом продукте.
Спасибо, что поделились впечатлениями от статьи, а также своим опытом. Да, действительно, не могу не согласиться с наблюдениями относительно продуктивности. Округление в большую сторону видится целесообразным решением, возьмем на заметку.
Добрый день! На данный момент мы только начинаем внедрение Docs-as-Code. Для некоторых продуктов документацию уже готовят на языке разметки (мы используем Markdown) и хранят в GitLab-репозиториях. Документация публикуется на портале документации. Сейчас мы работаем над внедрением данного подхода на тех продуктовых направлениях, где документация пока выпускается в форматах .docx и .pdf.
Спасибо за увлекательный и полезный материал. Особо ценным считаю, что Вы не просто поделились своим подходом и инструментарием, но и указали, какие сложности у Вас возникли в процессе. Массив работы в рамках подготовки документа впечатляет.
НЕ согласна с комментарием о том, что 105 часов на 24 страницы — это на грани разумного. Во-первых, в данном случае речь идет о целом проекте по разработке документа, так как объединяет разноплановую работу: аналитику, подготовку текста, выработку структуры, дизайн, верстку, редактирование. Можно за 105 часов написать 100 страниц, только какой в этом смысл, если пользователь в них просто потеряется из-за воды, плохой структуры, неясных и расплывчатых формулировок.
Мне понравилось, что Вы делаете акценты на актуальных и наболевших вопросах для технического писателя. Одним из таких для меня оказался вопрос о том, какую дополнительную информацию включать в руководство пользователя, а какую нет. Понравился ваш подход и отработка замечаний от пользователей по этой теме. Возьму на вооружение.
Только вот боюсь, Adobe InDesign для неопытного пользователя может оказаться сложноватым и потребует дополнительных сил и времени на начальных этапах использования. Но внешний вид документа от его использования определенно выигрывает. А внешний вид также влияет на читабельность, легкость использования и на пользовательское впечатление об описываемом продукте.
Спасибо за статью, читала с большим интересом!
Будет очень интересно почитать!
Спасибо, что поделились впечатлениями от статьи, а также своим опытом. Да, действительно, не могу не согласиться с наблюдениями относительно продуктивности. Округление в большую сторону видится целесообразным решением, возьмем на заметку.
Добрый день! На данный момент мы только начинаем внедрение Docs-as-Code. Для некоторых продуктов документацию уже готовят на языке разметки (мы используем Markdown) и хранят в GitLab-репозиториях. Документация публикуется на портале документации. Сейчас мы работаем над внедрением данного подхода на тех продуктовых направлениях, где документация пока выпускается в форматах .docx и .pdf.