В этой статье обсуждается техническое письмо и обсуждается, как вы адаптируете процесс написания на разные этапы требований и требований цикла разработки программного обеспечения (SDLC).
Хотя в SDLC есть много шагов, в этой статье перечислены только важные шаги SDLC. Они
1. Сбор требований
2. Анализ и дизайн
3. Кодирование
4. Обзор этапа кода и тестирования
5. Запуск (релизы Alpha и Beta)
6. Техническое обслуживание
. Каждый программный проект имеет свою собственную настраиваемую структуру SDLC.
Все зарезервированные издания фреймворков зависят от скелетной структуры вышеуказанной структуры SDLC.
Как и любой проект программного обеспечения, зависит от SDLC, таким же образом каждый проект документации также зависит от цикла разработки документа (DDLC). Структура DDLC делится на следующие этапы:
1. Понимать требования к продукту / проекту
2. Анализ аудитории
3. Определение форматов вывода (.PDF, интерактивная справка) и документов
4. Сброс документов и графических инструментов
5. Сбор базовых или исходных документов
6. Разработка шаблонов
7. Временные рамки и оценки
8. Идентификация экспертов в области предметов (МСП) и контактных пунктов
9. Идентификация экспертных, технических и редакционных обозревателей
10. Создание плана документации
11. Содержание (TOC)
12. Создание контента
13. Управление циклами инспекции
14. Включая комментарии к обзорам
15. Конечный результат
Все предшествующие этапы структуры DDLC можно суммировать в пяти подкатегориях, которые, в свою очередь, могут быть отображены на каждый шаг SDLC. Пять подытожированных подкатегорий
1. Подготовка плана документации
2. Контентное письмо
3. Просмотр содержимого
4. Поставка документа
5. Поддержание документа
Поскольку каждый проект документации в поле программного обеспечения зависит от соответствующего проекта / продукта, его базовая основа SDLC должна быть сопоставлена с DDLC соответствующего проекта документации.
Отображение SDLC. DDLC
1. Анализ и проектирование. Подготовка плана документации
2. Кодирование Запись содержимого
3. Обзор кода и этап тестирования. Обзор содержимого
4. Запуск (альфа-и бета-версии) Публикация документа
5. Поддержание документа обслуживания (с учетом улучшения функциональности и модификации)
Как видно из предыдущего сопоставления, каждый процесс в SDLC сопоставляется с соответствующим процессом в DDLC. Большинство компаний, в частности компании, выпускающие продукцию, хотят, чтобы документация была готова, пока продукт не появится на рынке.
Для компаний, использующих методологию Agile, когда продукт находится в разработке, улучшения, исправления и т. Д. Часто появляются на каждой итерации. Подобно изменениям, внесенным в код, таким же образом должны быть внесены изменения в соответствующую документацию для сохранения результатов в соответствии с требованиями клиента / рынка.