@IvanN777

В чем лучше составлять тех документацию для работающего проекта?

Так получилось, что меня назначили старшим, на умирающий проект, засраный в хлам.
По которому и документации то нет и тестами не пахло.
Я хочу начать вести документацию в особенности по процессам.
Так-как надо понимать что-как работает и чтобы это видела команда.
И для написания тестов и рефакторинга она пригодится.
Я уже смотрел некоторый обзор документаций.
Но так-как тут люди весьма интересные, решил посоветоватся.
Хочется найти что-то неочень сложное для освоения, чтобы это не отняло много времени.
Если кто-то, что-то подобное делал, буду рад узнать.
  • Вопрос задан
  • 478 просмотров
Пригласить эксперта
Ответы на вопрос 6
eduardtibet
@eduardtibet
Technical Writer / Documentation Engineer
IvanN777 , чтобы привести свои мысли в порядок, начните с этого ответа: Как лучше сделать документацию компании?
Ответ написан
Комментировать
У нас в команде используется DokuWiki. Есть поиск по документации, история прежних правок и т.д. Удобнее чем Word.
Установка в Ubuntu/Debian Linux проста, через штатный менеджер.
Касаемо документации стоит составить карту различных частей проекта и выставить ссылки на них в иерархии. Можно прикрепить изображения различных диаграмм, ссылки на внешние ресурсы и т.д. Также удобно ссылаться на какие-то внутренние системы, допустим JIRA: [[jira>issue-12345]]
В DokuWiki используются пространства:имён для ведения иерархии.
Ответ написан
Комментировать
@402d
начинал с бейсика на УКНЦ в 1988
в коде добавляешь комментарии и в IDE начинает появляться подсказки , а также можно сгенерировать html документацию
https://www.phpdoc.org/
https://github.com/phpDocumentor/phpDocumentor2
Ответ написан
@LuchS-lynx
инженер-ПТО
Я бы смотрел в сторону wiki движков. На мой взгляд самые функциональные, с учётом плагинов, это mediawiki, dokuwiki, twiki, xwiki, confluence. На мой взгляд последние 2 имеют более дружелюбный интерфейс для юзера.
Ответ написан
Комментировать
@karminski
Senior PHP /React.js developer
Microsoft Word, Google Docs
Ответ написан
Комментировать
Используй MD
Ответ написан
Комментировать
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы