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

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