Лучшие практики для хранения и организации документации? [закрыто]

Closed . Этот вопрос основан на мнении . В настоящее время он не принимает ответы.

Хотите улучшить этот вопрос? Обновите вопрос, чтобы на него можно было ответить фактами и цитатами, редактируя это сообщение .

Закрыто в прошлом году .

I ' Мне было поручено разработать базовые принципы организации документации. В настоящее время моя компания использует смесь Wiki и случайных документов, которые либо находятся в общих сетевых папках, либо зарегистрированы в репозитории исходного кода. Я знаю, что один размер может не подходить всем, но каковы некоторые из лучших практик? Я предполагаю, что некоторые документы относятся к исходному коду, а некоторые - сами по себе, но это то, что я здесь, чтобы узнать. Вот что у нас есть:

Требования
Исследовательская документация (например, результаты тестов показывают, что нам нужно оптимизировать существующее приложение или добавить функцию)
Архитектура / дизайн
Технические
Конфигурация / deployment
Конечный пользователь

Дополнительно:

Возможности / демонстрация (для продажи)
Документация поставщика (например, наш хостинг-провайдер)

Также - должны ли документы быть организованы по проектам (приложениям) или по типу (Требования к конечному пользователю)?

Спасибо

задан Alerty 29 March 2011 в 00:29

0 ответов

Другие вопросы по тегам:

documentation project-management standards maintenance

Лучшие практики для хранения и организации документации? [закрыто]

0 ответов

Похожие вопросы: