Faran Saleem Ответов: 1

Внутренняя документация по разработке программного продукта


Здравствуйте разработчики,

Надеюсь, у тебя все хорошо.
Я создал программный продукт для своей организации и теперь хочу создать "внутренний документ разработки". Документация должна объяснять все и вся, включая рабочий процесс системы, а также кодирование.
Цель состоит в том, чтобы разработать документ, который поможет как нетехническим, так и техническим пользователям, чтобы он мог помочь им понять мельчайшие детали продукта.
Этот документ также должен помочь команде технической поддержки или любому новому разработчику понять логику и код продукта.
Продукт разработан с использованием ASP.NET и MS-SQL.
Я был бы очень признателен, если бы вы помогли мне в этом отношении или привели несколько примеров уже созданных документов, так как я раньше не делал ни одного документа и хочу создать лучший.

Огромное спасибо.

Что я уже пробовал:

Поиск в интернете относительно документации, но я не могу найти ни одного образца документа.

[no name]

"я не могу найти ни одного образца документа", образец документа для чего? В интернете должны быть тысячи и тысячи образцов документов, поэтому я не могу поверить, что вы очень старались.

1 Ответов

Рейтинг:
0

Cynnie Jia

вы можете использовать GhostDoc,чтобы что-то сделать, когда начинаете писать код.
Это может помочь вам создать документацию по программе.


Faran Saleem

Я проверил его, но на их сайте написано, что он не предназначен для организации.
Я хочу иметь надлежащую документацию, я могу написать ее сам, но мне было бы гораздо легче, если бы я мог получить образец откуда-нибудь, который мог бы помочь мне понять, как должен выглядеть технический документ.