Гость
Форумы / Программирование [игнор отключен] [закрыт для гостей] / Практики документирования / 8 сообщений из 8, страница 1 из 1
24.01.2020, 18:03
    #39918507
dab2
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Практики документирования
Народ, у кого хорошие практики документирования Схема БД - структурная схема - бизнес-процессы - интерфейс + комменты/идеи/планы? Поделитесь инструментами!
...
Рейтинг: 0 / 0
24.01.2020, 21:48
    #39918567
hVostt
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Практики документирования
dab2,

Может лучше начать с описания проблем, задач, контекста?
...
Рейтинг: 0 / 0
30.01.2020, 16:39
    #39920582
dab2
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Практики документирования
hVostt,

ERP система розничной торговли. Уже сделана, осталось сделать удобоваримое описание.
...
Рейтинг: 0 / 0
30.01.2020, 16:50
    #39920589
Малыхин Сергей
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Практики документирования
Любой вики движек
...
Рейтинг: 0 / 0
30.01.2020, 19:06
    #39920672
Anatoly Moskovsky
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Практики документирования
...
Рейтинг: 0 / 0
31.01.2020, 16:32
    #39921068
tchingiz
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Практики документирования
dab2
Народ, у кого хорошие практики документирования Схема БД - структурная схема - бизнес-процессы - интерфейс + комменты/идеи/планы? Поделитесь инструментами!

что такое хорошая практика?

слово doxygen известно?
...
Рейтинг: 0 / 0
31.01.2020, 17:52
    #39921104
mayton
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Практики документирования
dab2
Народ, у кого хорошие практики документирования Схема БД - структурная схема - бизнес-процессы - интерфейс + комменты/идеи/планы? Поделитесь инструментами!

В проследнее время почти все рисуем в https://www.draw.io/
Оттужа-же линком картинки пристегиваются к jira, confluence.

Отдельное написание документации по проекту в виде Word например я не видел уже лет 8.
Почти всё что можно было втащить в confluence - затаскивается. В README.md в GitLab в каком-то своём формате.
И иногда компилируем документацию через javadoc plugin. Но обычно редко.
...
Рейтинг: 0 / 0
01.02.2020, 23:39
    #39921384
hVostt
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Практики документирования
dab2,

Если у вас хорошо и правильно откомментированный код, то вы можете сгененировать документацию к публичным интерфейсам, методам, контрактам.

Если у вас есть публичные АПИ методы и они также имеют документацию, то вы можете генерировать OpenAPI спецификацию.

Если у вас все в БД все таблицы имеют комментарии, хорошую и правильную нормализацию, то вы можете получить схему БД в физическом и логическом видах. Или соответствующие модели имеют комментарии, из которых можно получить описание моделей, можно получить соответствующие диаграммы.

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

Ну и если кто-то вам рассказывает, что комментарии в коде это для лохов, какие-то идиотские истории про "самодокументированный" код и про что-то там "самодокументированное", просто плюньте этим товарищам в лицо.

Потому что, если у вас всего этого нет, но вам это нужно, то либо придётся пускать пыль в глаза и на коленке изобретать какую-то бесполезную фигню для отвода глаз, либо выделить серьёзные ресурсы и много времени на документирование всей системы, ну и на актуализацию, соответственно -- в процессе разработки.
...
Рейтинг: 0 / 0
Форумы / Программирование [игнор отключен] [закрыт для гостей] / Практики документирования / 8 сообщений из 8, страница 1 из 1
Целевая тема:
Создать новую тему:
Автор:
Найденые пользователи ...
Разблокировать пользователей ...
Читали форум (0):
Пользователи онлайн (0):
x
x
Закрыть


Просмотр
0 / 0
Close
Debug Console [Select Text]