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

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

    7. c-sharp

c#

.net

documentation

2022-09-11T09:04:35+00:00
Вопросы с похожей тематикой, как у вопроса:

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

Как документировать возникшие исключения в c # /. Net

Как добавить всплывающую подсказку к документации к классам, методам, свойствам и т. Д. В C#?

Могу ли я сгенерировать файлы .MD из XML-документации?

Пример кода .NET для поставщика удостоверений SAML

Способы синхронизации интерфейса и комментариев реализации в C#

Visual Studio с DoxyGen для документации или что-то еще?

Как ссылаться на константы перечисления в c # xml docs

Документирование перегруженных методов с одинаковыми комментариями XML

Как задокументировать свойство класса

Ссылка на универсальный тип в комментарии к XML-коду

Наследовать документацию на C#?

Правила / рекомендации по документированию кода C#?

Проблемы с запуском epstopdf. Проверьте вашу установку TeX

Создать html-документацию для кода C#