Я закончил веб-приложение, которое в основном разработано на PHP и является просто очередным веб-приложением. Обычно, когда я доставляю окончательный рабочий выпуск, я просто передаю клиенту документацию по коду и информацию об архитектуре. Однако для этого конкретного проекта клиент настаивает на том, чтобы иметь полные входные и выходные данные о проекте.
Так что мне просто интересно ... Каковы обязательные технические и нетехнические документы, которые я могу предоставить своему клиенту помимо документации по коду и архитектуре?
(Также было бы неплохо поразить клиента различными статистическими данными и данными о проекте, чтобы он на самом деле знал объем работы и насколько крутой продукт на самом деле.)
Ответы:
Я думаю, что список должен включать в себя:
Не все эти вещи могут быть доступны (или необходимы) для каждого проекта, но я думаю, что это хорошее общее руководство.
источник
В дополнение к действительно хорошему ответу FrustratedWithFormsDesigner, я хотел бы сказать, что входит в нетехнические документы (как мы это сделали):
предложение, которое вы сделали:
которые вместе являются своего рода контрактом о том, что вы должны делать и что вы ожидаете
от клиента в ходе разработки, а также о предполагаемом времени и стоимости.
спецификация, включающая протоколы проверки, варианты использования и планы испытаний, результаты испытаний
дизайн в UML и все соответствующие документы
документация исходного кода (doxygen или что-то еще)
руководство и руководство по установке
окончательный фактический объем ресурсов (время и деньги), использованных для проекта, так что вы можете написать счет-фактуру
некоторые клиенты также хотят протоколы собраний, которые являются расширением упомянутого выше «документа о решениях»
Надеюсь, это то, что вы искали.
источник
Следуйте той документации, которая применима к вашему проекту из следующего. У вас, возможно, уже есть некоторые из них.
Техническая документация:
Подготовьте документы со скриншотами и выделите соответствующий код (при необходимости) для следующего:
Введите неверные данные и покажите, что это невозможно сделать, так как вы провели проверку данных на переднем и заднем концах.
/* This step is not applicable if you have not used any object for getting direct input from the user like Text Field as it is obvious that you cannot get invalid data through indirect input. */
Покажите, что в программе нет ошибок или несоответствий в данных, если в сервере или клиентской системе произошел внезапный сбой, объяснив соответствующий код.
Вы должны проверить их самостоятельно, прежде чем задокументировать их, чтобы, если ваш клиент запросил демонстрацию с примерами данных, вы могли показать, как на самом деле работает проект. Также убедитесь, что ваш код переднего плана имеет соответствующие строки комментариев.
Наконец, завершите статистику, такую как общее количество строк кода, общее количество дней, потраченных на проект, общее количество раз, когда вы проверили проект, список всех используемых приложений и другую техническую и нетехническую информацию.
Нетехническая документация:
источник
Будь осторожен
Потенциальная документация, которую вы могли бы предоставить клиенту, практически безгранична. Дополнительное время, необходимое для создания документации, которой у вас еще нет, не оплачивается.
Почему клиенту нужна эта документация (помимо исходного кода)? Что будет с этим сделано? Кто это для?
Ответы на эти вопросы помогут сузить рамки того, что нужно доставить.
Крайне важно, чтобы вы и клиент согласовали, какую именно документацию следует доставить, и будут ли компенсированы какие-либо дополнительные усилия.
Не играйте в угадайку. Большая часть технической документации будет бесполезна для типичного (нетехнического) клиента.
источник
Вероятно, я бы разбил это на несколько категорий документов:
Гиды:
Служба поддержки:
Точки интеграции:
источник