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

Версия 1.22 от Alexandr Fokin на 2025/01/11 15:00
Последние авторы
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 |Процесс восстановления информации о системе основан либо на взаимодействии с самой системой, изучении ее текущего поведения, либо на изучение исходного кода системы.
15 |Дополнительная тема: создание такого подхода и окружения для работы, в котором участники (например основные: разработчик, аналитик) могут взаимодействовать между собой.
16 А именно (на основании текущего состояния и новых требований): вести обсуждение, принимать решения, отображать ключевые изменения перед выполнение работ.
17 )))
18 )))
19 |(% style="width:153px" %) |(% style="width:1327px" %)
20
21 ----
22
23 ==== Внутренние ссылки: ====
24
25 ====== Дочерние страницы: ======
26
27 {{children/}}
28
29 ====== Обратные ссылки: ======
30
31 {{velocity}}
32 #set ($links = $doc.getBacklinks())
33 #if ($links.size() > 0)
34 #foreach ($docname in $links)
35 #set ($rdoc = $xwiki.getDocument($docname).getTranslatedDocument())
36 * [[$escapetool.xml($rdoc.fullName)]]
37 #end
38 #else
39 No back links for this page!
40 #end
41 {{/velocity}}
42
43 ----
44
45 |[[Движки управления информацией и процессами, CRM>>doc:Движки управления информацией и процессами, CRM.WebHome]]|
46 |[[Вики движки и заметки>>doc:Движки управления информацией и процессами, CRM.Вики движки и заметки.WebHome]]|
47 | |