Изменения документа Документирование

Редактировал(а) Alexandr Fokin 2025/01/11 15:16

От версии 1.1 >
отредактировано Alexandr Fokin
на 2023/01/31 12:26
К версии < 1.14 >
отредактировано Alexandr Fokin
на 2025/01/11 14:47
>
Изменить комментарий: К данной версии нет комментариев

Комментарий

Подробности

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