Шаблоны для программного обеспечения (требования, проектные документы и т. Д.)

Question

Я пишу приложение, которое не просто (хорошо, чтобы быть амбициозным и т. Д.), Но нужно писать документы, такие как требования, элементы дизайна и т. Д.

Что было бы хорошим инструментом, который предоставляет шаблоны для всего этого?

Thanks

Answer 1

Рассмотрите возможность использования шаблонов.

Часто, когда вы видите проектные документы, которые были написаны на основе стандартного шаблона проектирования, они имеют тенденцию быть 80% шаблоном/наполнителем из шаблона и 20% фактическим полезным контентом.

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

Отсутствие очевидного шаблона является признаком отличного документа дизайна в моей книге.

Более редкий и стильный стиль лучше - хороший пример в моей книге - это что-то вроде документа спецификации языка C#, который, вероятно, у вас есть на вашем компьютере, если вы используете разработку Visual Studio для .NET. Это довольно строгий и превосходно лишенный наполнителя.

Answer 2

Есть много вариантов. Я уверен, но тот, который мы используем, основан на Google Docs - Gallery Template Gallery, вы переходите к шаблонам Google и просто загружаете его на свой Google диск, а затем делитесь им со своей командой. Это бесплатно и очень хорошо.
Кстати, имя шаблона в шаблоне Google является «Шаблон документа для разработки программного обеспечения».

https://drive.google.com/templates?q=software+design+document&sort=hottest&view=public