Что такое findslide.org?

FindSlide.org - это сайт презентаций, докладов, шаблонов в формате PowerPoint.


Для правообладателей

Обратная связь

Email: Нажмите что бы посмотреть 

Яндекс.Метрика

Презентация на тему Техническая документация

Содержание

Page ВведениеДокументация – набор документов, используемых при проектировании, создании и эксплуатации программного обеспечения
Техническая документацияИван ПознякInternal Training Page ВведениеДокументация – набор документов, используемых при проектировании, создании и эксплуатации программного обеспечения Как используетсяPage Page КлассификацияТехническая документацияProject VisionSAO (System Architecture Overview)SDD (System Design Document)API documentationDeployment/Integration/Installation GuideФункциональная Page «За» и «Против»ПлюсыЕдиный источник знаний на проектеОблегчает передачу знанийСпецифицирует как должен Page НаписаниеНам нужныПравильный человекПравильный шаблонВремя на написание документаВремя на ревью документаИспользуем полученную Page Шаблоны RUPhttp://www.ts.mah.se/RUP/RationalUnifiedProcess/wordtmpl/index.htmSoftware Architecture DocumentПримеры Место документации в разработке проектаPage Идея продуктаЦельВыбрать компанию которая реализует проектФормаДокумент либо иным образом оформленное видение будущей системыНаша реакцияСоздание RFXPage Обработка RFXЦельПолучить контракт на разработку приложенияФормаProposalTechnical VisionFunctional VisionCost $Технический специалистБизнес аналитикPage Technical VisionОриентация - заказчикЧто должно бытьОбзор системыТопология системыИспользуемая платформа/технологияОтветственности отдельных частейЧего писать Page Пример схемы для Technical Vision Фаза 0 / Фаза анализаЦельСобрать требования по проектуФормаSRSБизнес аналитикPage Начало разработки *Page ЦельРазработать архитектуру проекта, получить базу для его дальнейшего развитияФормаSAO / SDDCodeТехнический специалист Page System Architecture OverviewОриентация – тех. специалисты, разработчикиОдин из часто пишущихся документовЧаще Page Диаграммы  последовательностей Page Диаграммы классов Page System Design DocumentОриентация – тех специалисты, разработчикиОтличается от SAO более детальным Page Что писать в документацииВведениеОбзор системыОписание дизайнаАрхитектурные решенияАрхитектура системыПолитики и соглашенияДетальное описание системы Page ВведениеНазначение документаЦелевая аудитория для данного документаСсылки на другие документы, prerequirementsВажные понятия Page Обзор системыЗдесь дается общий обзор разрабатываемого продукта, включая следующие пункты:Общая функциональностьБазовые Page Описание дизайна: предположенияИспользуемое/требуемое ПО/железо Операционная система Требования к пользователям системы Возможность дальнейшего изменения системы Page Описание дизайна: ограниченияТребования по софту и железуДоступность различных ресурсов (Internet, printer Page Описание дизайна: принципыОписываются основные принципы, которыми следует руководствоваться при разработке и Page Архитектурные решенияВыбор языка/платформы/библиотеки, повторное использование готовых компонентВозможности по расширению системыОбнаружение, обработка Page Политики и соглашенияОписываются те решения, которые не сильно влияют на высокоуровневую Page Описание архитектуры системыДается общее представление об архитектурном устройстве приложенияДекомпозиция на компонентыВзаимодействие, Page Детальное описание системыКомпонент (модуль, класс, библиотека, ...)Назначение, роли и обязанностиПравила взаимодействия, Page Общие рекомендацииDRY (Don’t Repeat Yourself)Вещи, которые легко читаются из кода, можно Фаза приёмки ПОПроисходит валидация разработанного ПО на соответствие исходным требованиям и исправление Page Различные гайдыОриентация – широкие массыЧто должно бытьПростое понятное изложениеПошаговые инструкцииПроработка различных ситуаций/вариантов Фаза эксплуатации ПОДеньги заплатили, все довольны Для поддержки (фикса багов в гарантийный Page API DocumentationОриентация – разработчикНе забывать писать понятные комментарииРазличные утилиты для генерацииNDocSandcastleJavadocRdoc Page Спасибо за внимание
Слайды презентации

Слайд 2 Page
Введение
Документация – набор документов, используемых при проектировании,

Page ВведениеДокументация – набор документов, используемых при проектировании, создании и эксплуатации программного обеспечения

создании и эксплуатации программного обеспечения


Слайд 3 Как используется
Page

Как используетсяPage

Слайд 4 Page
Классификация
Техническая документация
Project Vision
SAO (System Architecture Overview)
SDD (System

Page КлассификацияТехническая документацияProject VisionSAO (System Architecture Overview)SDD (System Design Document)API documentationDeployment/Integration/Installation

Design Document)
API documentation
Deployment/Integration/Installation Guide
Функциональная документация
SRS (System Requirements Specification)
QA документация
Test

cases


Слайд 5 Page
«За» и «Против»
Плюсы
Единый источник знаний на проекте
Облегчает

Page «За» и «Против»ПлюсыЕдиный источник знаний на проектеОблегчает передачу знанийСпецифицирует как

передачу знаний
Специфицирует как должен работать конечный продукт
Позволяет задуматься о

проблемах до их появления
Минусы
Документацию нужно писать
Документацию нужно поддерживать в актуальном состоянии

Слайд 6 Page
Написание
Нам нужны
Правильный человек
Правильный шаблон
Время на написание документа
Время

Page НаписаниеНам нужныПравильный человекПравильный шаблонВремя на написание документаВремя на ревью документаИспользуем

на ревью документа
Используем полученную документацию
По необходимости обновляем
Шаги 3 и

4 – могут повторяться несколько раз до получения результата нужного качества

Слайд 7 Page
Шаблоны RUP
http://www.ts.mah.se/RUP/RationalUnifiedProcess/wordtmpl/index.htm
Software Architecture Document
Примеры

Page Шаблоны RUPhttp://www.ts.mah.se/RUP/RationalUnifiedProcess/wordtmpl/index.htmSoftware Architecture DocumentПримеры

Слайд 8 Место документации в разработке проекта
Page

Место документации в разработке проектаPage

Слайд 9 Идея продукта
Цель
Выбрать компанию которая реализует проект
Форма
Документ либо иным

Идея продуктаЦельВыбрать компанию которая реализует проектФормаДокумент либо иным образом оформленное видение будущей системыНаша реакцияСоздание RFXPage

образом оформленное видение будущей системы
Наша реакция
Создание RFX

Page


Слайд 10 Обработка RFX
Цель
Получить контракт на разработку приложения
Форма
Proposal
Technical Vision
Functional Vision
Cost

Обработка RFXЦельПолучить контракт на разработку приложенияФормаProposalTechnical VisionFunctional VisionCost $Технический специалистБизнес аналитикPage

$
Технический специалист
Бизнес аналитик

Page


Слайд 11 Technical Vision
Ориентация - заказчик
Что должно быть
Обзор системы
Топология системы
Используемая

Technical VisionОриентация - заказчикЧто должно бытьОбзор системыТопология системыИспользуемая платформа/технологияОтветственности отдельных частейЧего

платформа/технология
Ответственности отдельных частей
Чего писать не стоит:
Специфических технических вещей *

Page



Слайд 12 Page
Пример схемы для Technical Vision

Page Пример схемы для Technical Vision

Слайд 13 Фаза 0 / Фаза анализа
Цель
Собрать требования по проекту
Форма
SRS
Бизнес

Фаза 0 / Фаза анализаЦельСобрать требования по проектуФормаSRSБизнес аналитикPage

аналитик


Page


Слайд 14 Начало разработки *
Page
Цель
Разработать архитектуру проекта, получить базу

Начало разработки *Page ЦельРазработать архитектуру проекта, получить базу для его дальнейшего развитияФормаSAO / SDDCodeТехнический специалист

для его дальнейшего развития
Форма
SAO / SDD
Code
Технический специалист



Слайд 15 Page
System Architecture Overview
Ориентация – тех. специалисты, разработчики
Один

Page System Architecture OverviewОриентация – тех. специалисты, разработчикиОдин из часто пишущихся

из часто пишущихся документов
Чаще всего пишется до начала либо

в начале процесса разработки
Что должно быть
Общее описание архитектуры
Описание различных фич/механизмов
Различные UML диаграммы

Слайд 16 Page
Диаграммы последовательностей

Page Диаграммы последовательностей

Слайд 17 Page
Диаграммы классов

Page Диаграммы классов

Слайд 18 Page
System Design Document
Ориентация – тех специалисты, разработчики
Отличается

Page System Design DocumentОриентация – тех специалисты, разработчикиОтличается от SAO более

от SAO более детальным и глубоким рассмотрением отдельных частей

системы
Что должно быть
Схемы
Различные UML диаграммы
Возможно примеры/отрывки кода


Слайд 19 Page
Что писать в документации
Введение
Обзор системы
Описание дизайна
Архитектурные решения
Архитектура

Page Что писать в документацииВведениеОбзор системыОписание дизайнаАрхитектурные решенияАрхитектура системыПолитики и соглашенияДетальное описание системы

системы
Политики и соглашения
Детальное описание системы


Слайд 20 Page
Введение
Назначение документа
Целевая аудитория для данного документа
Ссылки на

Page ВведениеНазначение документаЦелевая аудитория для данного документаСсылки на другие документы, prerequirementsВажные

другие документы, prerequirements
Важные понятия и определения
Соглашения по обозначениям в

документе
Краткое содержимое всего документа

Слайд 21 Page
Обзор системы
Здесь дается общий обзор разрабатываемого продукта,

Page Обзор системыЗдесь дается общий обзор разрабатываемого продукта, включая следующие пункты:Общая

включая следующие пункты:
Общая функциональность
Базовые архитектурные решения
Например 3-tier architecture
Назначение и

ответственность отдельных частей приложения



Слайд 22 Page
Описание дизайна: предположения
Используемое/требуемое ПО/железо
Операционная система
Требования

Page Описание дизайна: предположенияИспользуемое/требуемое ПО/железо Операционная система Требования к пользователям системы Возможность дальнейшего изменения системы

к пользователям системы
Возможность дальнейшего изменения системы


Слайд 23 Page
Описание дизайна: ограничения
Требования по софту и железу
Доступность

Page Описание дизайна: ограниченияТребования по софту и железуДоступность различных ресурсов (Internet,

различных ресурсов (Internet, printer и т.п.)
Совместимость со стандартами
Требования по

предоставляемым интерфейсам/используемым протоколам
Требования к хранилищам данных (объемы данных и пр.)
Требования к системе безопасности
Ограничения по используемой памяти и т.п.
Требования по производительности
Требования к качеству

Слайд 24 Page
Описание дизайна: принципы
Описываются основные принципы, которыми следует

Page Описание дизайна: принципыОписываются основные принципы, которыми следует руководствоваться при разработке

руководствоваться при разработке и проектировании архитектуры будущего приложения
KISS (“keep

it simple stupid!”)
Упор на скорость/производительность в ущерб использованию памяти
Внешний вид/принцип работы как у существующего приложения
...
Желательно пояснение по каждому принципу

Слайд 25 Page
Архитектурные решения
Выбор языка/платформы/библиотеки, повторное использование готовых компонент
Возможности

Page Архитектурные решенияВыбор языка/платформы/библиотеки, повторное использование готовых компонентВозможности по расширению системыОбнаружение,

по расширению системы
Обнаружение, обработка ошибок и восстановление после них
Фреймворк

для работы с базой данных/внешним хранилищем данных
Механизмы синхронизации и параллельной обработки
Механизмы коммуникации
Использование внешних ресурсов

Слайд 26 Page
Политики и соглашения
Описываются те решения, которые не

Page Политики и соглашенияОписываются те решения, которые не сильно влияют на

сильно влияют на высокоуровневую организацию, однако влияют на детали

реализации тех или иных механизмов
Гайдлайны и соглашения
Внутренний протокол общения между отдельными модулями
Выбор отдельного алгоритма / паттерна программирования
Интерфейсы предоставляемые внешним системам
Организация кода по физической структуре каталогов и файлов

Слайд 27 Page
Описание архитектуры системы
Дается общее представление об архитектурном

Page Описание архитектуры системыДается общее представление об архитектурном устройстве приложенияДекомпозиция на

устройстве приложения
Декомпозиция на компоненты
Взаимодействие, роли и обязанности отдельных компонент

Здесь

же можно дать высокоуровневые описания различных подсистем/компонент

Слайд 28 Page
Детальное описание системы
Компонент (модуль, класс, библиотека, ...)
Назначение,

Page Детальное описание системыКомпонент (модуль, класс, библиотека, ...)Назначение, роли и обязанностиПравила

роли и обязанности
Правила взаимодействия, ограничения
Ресурсы, которые используются/управляются этим компонентом
Сервисы/интерфейсы

предоставляемые компонентом


Слайд 29 Page
Общие рекомендации
DRY (Don’t Repeat Yourself)
Вещи, которые легко

Page Общие рекомендацииDRY (Don’t Repeat Yourself)Вещи, которые легко читаются из кода,

читаются из кода, можно оставить без внимания, сделав соответствующую

ссылку
Следует избегать дублирования, выносить общие вещи в отдельные секции/документы и ставить ссылки
Желательно использовать больше диаграмм (классов, последовательностей) для демонстрации того как работает и устроена система

[ здесь могла бы быть реклама тренинга по UML ]

Слайд 30 Фаза приёмки ПО
Происходит валидация разработанного ПО на соответствие

Фаза приёмки ПОПроисходит валидация разработанного ПО на соответствие исходным требованиям и

исходным требованиям и исправление найденных багов
Активно участвуют практически все

QA, заказчик, бизнес-аналитик и разработчики

Page


Слайд 31 Page
Различные гайды
Ориентация – широкие массы
Что должно быть
Простое

Page Различные гайдыОриентация – широкие массыЧто должно бытьПростое понятное изложениеПошаговые инструкцииПроработка различных ситуаций/вариантов

понятное изложение
Пошаговые инструкции
Проработка различных ситуаций/вариантов


Слайд 32 Фаза эксплуатации ПО
Деньги заплатили, все довольны 
Для поддержки

Фаза эксплуатации ПОДеньги заплатили, все довольны Для поддержки (фикса багов в

(фикса багов в гарантийный период) а также для дальнейшего

развития функционала приложения может потребоваться API документация

Page


Слайд 33 Page
API Documentation
Ориентация – разработчик
Не забывать писать понятные

Page API DocumentationОриентация – разработчикНе забывать писать понятные комментарииРазличные утилиты для генерацииNDocSandcastleJavadocRdoc

комментарии
Различные утилиты для генерации
NDoc
Sandcastle
Javadoc
Rdoc




  • Имя файла: tehnicheskaya-dokumentatsiya.pptx
  • Количество просмотров: 220
  • Количество скачиваний: 1