Как стать автором
Обновить

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

Время на прочтение7 мин
Количество просмотров5.8K
Всего голосов 14: ↑11 и ↓3+13
Комментарии9

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

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

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

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

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

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

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

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

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

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

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

Довольно смешно, что в одной строке - два предложения. И второе переносится на следующую строку. Типичный совет

А следующий абзац прочитать не довелось?

Not publishing one sentence per line, no. Write like this for your eyes only. HTML or Markdown combine separate lines into one paragraph.

Делать скрин текста — вот что действительно странно.

Зарегистрируйтесь на Хабре, чтобы оставить комментарий

Публикации

Истории