Исходный код вики Документирование

Версия 1.19 от Alexandr Fokin на 2025/01/11 14:53
Последние авторы
1 |(% style="width:153px" %) |(% style="width:1327px" %)(((
2 |(% style="width:418px" %)Описание некоторой задачи и работы,
3 создающей или меняющей некоторый функционал.|(% style="width:890px" %)Снимок некоторой доработки.
4 Содержит информацию о внесенном изменение и возможно частично о состоянии функционала на момент начала доработки (также тут могут быть указаны обоснования для изменения).
5 Создается один раз и не актуализируется.
6 \\Ведение документации только в таком виде приводит к тому, что сложно понять фактическое актуальное состояние системы. Например если вести только технические задания на доработку системы.
7 |(% style="width:418px" %)Описание актуального состояния некоторого функционала.|(% style="width:890px" %)Снимок актуального состояния.
8 Требует поддержки и актуализации.
9 Содержит актуальную информацию о текущем поведении и наборе правил, структуре.
10 \\Процесс восстановления информации о системе основан либо на взаимодействии с самой системой, изучении ее текущего поведения, либо на изучение исходного кода системы.
11 \\Дополнительная тема: создание такого подхода и окружения для работы, в котором участники (например основные: разработчик, аналитик) могут взаимодействовать между собой.
12 А именно (на основании текущего состояния и новых требований): вести обсуждение, принимать решения, отображать ключевые изменения перед выполнение работ.
13 )))
14 |(% style="width:153px" %) |(% style="width:1327px" %)
15
16 ----
17
18 ==== Внутренние ссылки: ====
19
20 ====== Дочерние страницы: ======
21
22 {{children/}}
23
24 ====== Обратные ссылки: ======
25
26 {{velocity}}
27 #set ($links = $doc.getBacklinks())
28 #if ($links.size() > 0)
29 #foreach ($docname in $links)
30 #set ($rdoc = $xwiki.getDocument($docname).getTranslatedDocument())
31 * [[$escapetool.xml($rdoc.fullName)]]
32 #end
33 #else
34 No back links for this page!
35 #end
36 {{/velocity}}
37
38 ----
39
40 |[[Движки управления информацией и процессами, CRM>>doc:Движки управления информацией и процессами, CRM.WebHome]]|
41 |[[Вики движки и заметки>>doc:Движки управления информацией и процессами, CRM.Вики движки и заметки.WebHome]]|
42 | |