Какие основные элементы следует включить во Вспомогательную документацию?[закрыто]

Question

Я создал приложение, которое нуждается в "передаче" в группу поддержки в следующем месяце.

Приложение является довольно маленький (разработка 2 месяца), и состоит из двух клиентских приложений и базы данных, написана на c # для платформы Windows.

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

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

Итак, я предполагаю, что мои вопросы таковы:

1. Что обязательно должно содержаться в сопроводительном документе

2. Какие дополнительные элементы вы добавили в сопроводительные документы, чтобы сделать их более полезными?

3. Какие еще действия можно выполнить перед передачей, чтобы облегчить всем нам жизнь?

Answer 1

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

• документация по коду (javadoc, doxygen и т.д.)
• подробная информация о процессе сборки
  • где взять источник тока
  • как регистрировать ошибки (они обязательно произойдут)
  • маршрут для предоставления исправлений либо источнику, либо клиентам
• как это работает (просто, но часто упускается из виду)
• настраиваемые пользователем части (например, есть компонент сценариев)
• основные контакты для каждого компонента, иначе называемый путь эскалации
• поощрение за обратную связь от Службы поддержки относительно того, что еще они хотят увидеть

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

Answer 2

1. Функциональная спецификация (если она у вас есть)
2. Руководство пользователя.Создайте его, если у вас его нет
3. Техническое руководство, содержащее
   • Схема развертывания
   • Используемое программное обеспечение
   • Детали конфигурации и сборки
   • Данные об IP-адресе сервера и паролях администратора / oracle / websphere
4. Документ для тестирования
5. Чрезмерный просмотр документа, выдающего
   • Где хранятся все документы
   • Репозиторий управления версиями и сведения о его проекте / пользователе
   • Имя пользователя / пароль приложения
6. Любые вспомогательные SQL / инструменты и т.д., созданные командой разработчиков, для анализа, загрузки данных и т.д.

Answer 3

1. Включите скриншоты операций и выходных данных.
2. Предпочитайте "легко обновляемый онлайн" документ doc (похожий на wiki) вместо бумажного или pdf.
3. Если он находится в Сети, сделайте его доступным для поиска и с перекрестными ссылками.

Answer 4

• Пользовательский интерфейс - это аккуратная вещь (картинки, описания и т. Д.).
• Краткое описание различных функций приложения

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