Шаблон передачи программного обеспечения / системы - есть ли какие-нибудь хорошие примеры?

От меня требуется передать нашим редакторам контент для обновленного корпоративного веб-сайта, который я только что выпустил. Видимо тренировки с нотами недостаточно. Справедливо.

Так вырисовывается еще более устрашающая документация. После довольно короткого изучения Google я не могу найти какой-либо подходящий и пригодный для использования шаблон, который можно было бы использовать в качестве основы для передачи веб-сайта или веб-приложения. Самый полезный список предметов, которые должны появиться в таком документе, я нашел на Experts Exchange (враг):

  1. Обзор системы, общее введение
  2. процессы и межведомственные процессы
  3. конфигурация системы, настройка и зависимости
  4. технические требования, особенности и ограничения
  5. процесс поддержки
  6. списки эскалации и контактная информация для соответствующих сторон для устранения неполадок

Это хорошая основа для работы - я могу "сделать это глупее" для пользователей, которые будут только вносить изменения в контент на сайте, но знает ли кто-нибудь о хорошем стандартном шаблоне, доступном в облаке? Что еще нужно добавить в этот список?

Стоит ли изучать PHP в 2026-2027 годах?
Стоит ли изучать PHP в 2026-2027 годах?
Привет всем, сегодня я хочу высказать свои соображения по поводу вопроса, который я уже много раз получал в своем сообществе: "Стоит ли изучать PHP в...
Поведение ключевого слова "this" в стрелочной функции в сравнении с нормальной функцией
Поведение ключевого слова "this" в стрелочной функции в сравнении с нормальной функцией
В JavaScript одним из самых запутанных понятий является поведение ключевого слова "this" в стрелочной и обычной функциях.
Приемы CSS-макетирования - floats и Flexbox
Приемы CSS-макетирования - floats и Flexbox
Здравствуйте, друзья-студенты! Готовы совершенствовать свои навыки веб-дизайна? Сегодня в нашем путешествии мы рассмотрим приемы CSS-верстки - в...
Тестирование функциональных ngrx-эффектов в Angular 16 с помощью Jest
В системе управления состояниями ngrx, совместимой с Angular 16, появились функциональные эффекты. Это здорово и делает код определенно легче для...
Концепция локализации и ее применение в приложениях React ⚡️
Концепция локализации и ее применение в приложениях React ⚡️
Локализация - это процесс адаптации приложения к различным языкам и культурным требованиям. Это позволяет пользователям получить опыт, соответствующий...
Пользовательский скаляр GraphQL
Пользовательский скаляр GraphQL
Листовые узлы системы типов GraphQL называются скалярами. Достигнув скалярного типа, невозможно спуститься дальше по иерархии типов. Скалярный тип...
1
0
30 798
1
Перейти к ответу Данный вопрос помечен как решенный

Ответы 1

Ответ принят как подходящий

Я не знаю доступных шаблонов как таковых, но также см. Этот вопрос: Какие основные элементы следует включить в вспомогательную документацию?

Спасибо. Это будет полезно. Похоже, октябрь - это месяц для всех, кто должен делать свою вспомогательную документацию ...

Phil.Wheeler 20.10.2008 05:03

Другие вопросы по теме