|
Практики документирования
|
|||
---|---|---|---|
#18+
Народ, у кого хорошие практики документирования Схема БД - структурная схема - бизнес-процессы - интерфейс + комменты/идеи/планы? Поделитесь инструментами! ... |
|||
:
Нравится:
Не нравится:
|
|||
24.01.2020, 18:03 |
|
Практики документирования
|
|||
---|---|---|---|
#18+
dab2, Может лучше начать с описания проблем, задач, контекста? ... |
|||
:
Нравится:
Не нравится:
|
|||
24.01.2020, 21:48 |
|
Практики документирования
|
|||
---|---|---|---|
#18+
hVostt, ERP система розничной торговли. Уже сделана, осталось сделать удобоваримое описание. ... |
|||
:
Нравится:
Не нравится:
|
|||
30.01.2020, 16:39 |
|
Практики документирования
|
|||
---|---|---|---|
#18+
Любой вики движек ... |
|||
:
Нравится:
Не нравится:
|
|||
30.01.2020, 16:50 |
|
Практики документирования
|
|||
---|---|---|---|
#18+
В вики движке Gitlab кстати можно диаграмы делать https://docs.gitlab.com/ee/user/markdown.html#diagrams-and-flowcharts https://docs.gitlab.com/ee/administration/integration/plantuml.html ... |
|||
:
Нравится:
Не нравится:
|
|||
30.01.2020, 19:06 |
|
Практики документирования
|
|||
---|---|---|---|
#18+
dab2 Народ, у кого хорошие практики документирования Схема БД - структурная схема - бизнес-процессы - интерфейс + комменты/идеи/планы? Поделитесь инструментами! что такое хорошая практика? слово doxygen известно? ... |
|||
:
Нравится:
Не нравится:
|
|||
31.01.2020, 16:32 |
|
Практики документирования
|
|||
---|---|---|---|
#18+
dab2 Народ, у кого хорошие практики документирования Схема БД - структурная схема - бизнес-процессы - интерфейс + комменты/идеи/планы? Поделитесь инструментами! В проследнее время почти все рисуем в https://www.draw.io/ Оттужа-же линком картинки пристегиваются к jira, confluence. Отдельное написание документации по проекту в виде Word например я не видел уже лет 8. Почти всё что можно было втащить в confluence - затаскивается. В README.md в GitLab в каком-то своём формате. И иногда компилируем документацию через javadoc plugin. Но обычно редко. ... |
|||
:
Нравится:
Не нравится:
|
|||
31.01.2020, 17:52 |
|
Практики документирования
|
|||
---|---|---|---|
#18+
dab2, Если у вас хорошо и правильно откомментированный код, то вы можете сгененировать документацию к публичным интерфейсам, методам, контрактам. Если у вас есть публичные АПИ методы и они также имеют документацию, то вы можете генерировать OpenAPI спецификацию. Если у вас все в БД все таблицы имеют комментарии, хорошую и правильную нормализацию, то вы можете получить схему БД в физическом и логическом видах. Или соответствующие модели имеют комментарии, из которых можно получить описание моделей, можно получить соответствующие диаграммы. Если архитектура у вас найс, то учитывая вышеописанное, вы можете получить сгенерированную доку по логике процессов и архитектуре. Ну и если кто-то вам рассказывает, что комментарии в коде это для лохов, какие-то идиотские истории про "самодокументированный" код и про что-то там "самодокументированное", просто плюньте этим товарищам в лицо. Потому что, если у вас всего этого нет, но вам это нужно, то либо придётся пускать пыль в глаза и на коленке изобретать какую-то бесполезную фигню для отвода глаз, либо выделить серьёзные ресурсы и много времени на документирование всей системы, ну и на актуализацию, соответственно -- в процессе разработки. ... |
|||
:
Нравится:
Не нравится:
|
|||
01.02.2020, 23:39 |
|
|
start [/forum/topic.php?fid=3&gotonew=1&tid=538884]: |
0ms |
get settings: |
11ms |
get forum list: |
15ms |
get settings: |
11ms |
get forum list: |
15ms |
check forum access: |
4ms |
check topic access: |
4ms |
track hit: |
29ms |
get topic data: |
13ms |
get first new msg: |
8ms |
get forum data: |
3ms |
get page messages: |
55ms |
get tp. blocked users: |
2ms |
others: | 9574ms |
total: | 9744ms |
0 / 0 |