Svetafo 8 ноя 2022 в 19:48

Ошибки технарей, которые пишут документацию для разработчиков

7 мин

Анализ и проектирование систем*Управление разработкой*Подготовка технической документации*

Технотекст 2022

+13

Комментарии 9

LeshaRB 9 ноя 2022 в 10:57

Забавно будет, если потом разработчик не будет читать ее....

Меня вот что интересует

Используйте среду разработки (IDE) вместо Confluence, GoogleDocs, Word. Среда разработки позволяет подключать плагины и писать собственные скрипты для разработки документации. VSCode — идеальный инструмент для меня, у вас могут быть свои фавориты среди приложений

А как обмениваться ей тогда как, по почте? Или на сервере будет лежать? В этом плане удобнее тот же Confluence или GDocs

Svetafo 9 ноя 2022 в 11:04

Да вот, минусят только разработчики))

А github, bitbucket, gitlab на что? Они же и нужны для обмена и совместной разработки)

Twoy 9 ноя 2022 в 13:03

Посоветуйте, пожалуйста, плагины для VSCode, чтобы удобно вести документацию

Svetafo 9 ноя 2022 в 13:03

Отдельный пост сделаю

Svetafo 11 ноя 2022 в 00:02

Вот, советую) https://habr.com/ru/post/698702/

Katerina_yrs 15 ноя 2022 в 10:11

Знакомо. Мы с своей компании научились по шаблону создавать задачи на разработку или исправление багов. Уже становится легче обсуждать и отслеживать, что сделано, что нет.

Svetafo 15 ноя 2022 в 10:15

Это у нас тоже есть. Про организацию процесса нужен отдельный текст, это самостоятельная крутая тема. Здесь мне хотелось поговорить (и выговорить наболевшее) о контенте, его качестве и о восприятии работы с самими текстами. Шаблоны — полезная вещь, и в тексте я упоминала об этом.