Здравствуйте. Как вы считаете что должно входить в документацию на программу? У меня понимание сейчас такое.
— Понятный текст программы, назначение классов, назначение всех членов класса, коменнтарии в методе.
— Структура и функционирование: общее описание, описание для отдельных возможностей программы (выжных, сложных).
Структуру можно показать диаграммой кооперации, классов, функционирование — блок-схемой алгоритма.
— Форматы файлов, протоколов.
— некоторые полезные документы из ГОСТов, например, Руководство пользователя.

Что вы подразумеваете под документацией на программу? Кто будет это читать? Пользователи, программисты (если у вас SDK) или патентный юрист? Что должно входить в документацию определяется аудиторией, которая будет ее читать.

N>Здравствуйте. Как вы считаете что должно входить в документацию на программу? У меня понимание сейчас такое.
N>- Понятный текст программы, назначение классов, назначение всех членов класса, коменнтарии в методе.
N>- Структура и функционирование: общее описание, описание для отдельных возможностей программы (выжных, сложных).
N>Структуру можно показать диаграммой кооперации, классов, функционирование — блок-схемой алгоритма.
N>- Форматы файлов, протоколов.
N>- некоторые полезные документы из ГОСТов, например, Руководство пользователя.

Здравствуйте, decradle, Вы писали:


Читать будут программисты, которые будут поддерживать программу.

D>Что вы подразумеваете под документацией на программу? Кто будет это читать? Пользователи, программисты (если у вас SDK) или патентный юрист? Что должно входить в документацию определяется аудиторией, которая будет ее читать.

N>>Здравствуйте. Как вы считаете что должно входить в документацию на программу? У меня понимание сейчас такое.
N>>- Понятный текст программы, назначение классов, назначение всех членов класса, коменнтарии в методе.
N>>- Структура и функционирование: общее описание, описание для отдельных возможностей программы (выжных, сложных).
N>>Структуру можно показать диаграммой кооперации, классов, функционирование — блок-схемой алгоритма.
N>>- Форматы файлов, протоколов.
N>>- некоторые полезные документы из ГОСТов, например, Руководство пользователя.

On 10.10.2012 14:31, nekoriu wrote:
> From: *nekoriu* </Users/54949.aspx>

> Читать будут программисты, которые будут поддерживать программу.

1. Исходники с комментариями
2. Какое-нибудь общее описание архитектуры — модули, слои и т.п. Не
больше нескольких страниц.
3. Руководство по сборке / деплойменту (если надо).

Диаграммы сами сгенерят, если надо будет.

--
WBR,
Serge.

Здравствуйте, nekoriu, Вы писали:

N>Здравствуйте, decradle, Вы писали:


N>Читать будут программисты, которые будут поддерживать программу.

Спецификации нужны, чтобы было понятно, что вообще делает программа.
Очень сложно поддерживать программу, про которую никто не знает, что она должна делать.
Автоматические тесты тоже нужны.

Ну и то, что ты упомянул тоже не помешает.

Спасибо.