Re[2]: Документация на программу
От: nekoriu Россия  
Дата: 10.10.12 10:31
Оценка:
Здравствуйте, decradle, Вы писали:


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

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


N>>Здравствуйте. Как вы считаете что должно входить в документацию на программу? У меня понимание сейчас такое.

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