Я собираюсь создать библию сайта или документацию нашего веб-сервера?
Я создаю это в MS Word, чтобы создать 3-кольцевую папку с вкладками, полные документации всего о нашем веб-сервере.
Какие основные категории я должен включить?
У нас есть 2 сервера, оба окна, 1 для веб, 1 для SQL Server, веб 1, работает iis7 и coldfusion.
У меня нет обучения системному администратору, только то, что я изучил. Например, я предпочел бы иметь больше информации, чем никакой информации, например, когда мы только что перенесли наши серверы, и мы пропустили кучу вещей, потому что не было документации.
Так я хочу сделать основательную работу? Я не возражаю против этого как вики, но мой начальник и коллеги не очень знакомы с вики и тем, как их использовать. Я склонен быть анальным в нашей группе, желая расставить все точки над i и получить все задокументированные.
Какие-либо предложения?
2 ответа
В определенной степени то, что вы включаете, будет зависеть от того, кого вы документируете. Вы документируете для администраторов? Для пользователей? Для программистов? Все вышеперечисленное? Точно так же, как когда вы разрабатываете сайт, вам нужно посмотреть варианты использования и решить их.
Вещи, которые я считаю важными для документации, предоставляемой мне как программисту и / или системному администратору:
- как создаются резервные копии
- как должны быть восстановлены резервные копии
- как настроить сайт с нуля (необходимое программное обеспечение, процесс установки, настройка и т. д.)
- список зависимостей (требуется CF, SQL Server, требуется x)
- документирование любого используемого API
- оригиналы требований документов, изменения документов (если они существуют)
- информация о том, как создать / использовать администрацию
- процесс изменения доступа при выходе пользователя (отзыв доступа пользователя, изменение общих паролей и т. д.)
- любые пользовательские / клиентские / специфичные для процесса настройки
- любые сценарии "Гоча"
- любая существующая документация для пользователей
- запланированные задачи и их графики
- процессы, которые должны выполняться регулярно (обновления индекса, дефрагментация и т. д.) как часть обслуживания
Если вы создаете электронный источник, например, вики, было бы неплохо иметь:
- оригинальные композиции и макеты
- источники изображения
- флэш-файлы.fla
- ссылки с существующего сайта на требования / изменения документов
- текущая копия кода выпуска с указанием даты / версии / и т. д. обновляется с каждым основным выпуском или по расписанию (например, ежемесячно).
Используйте OneNote для своей документации вместо Word
- Несколько пользователей могут использовать его одновременно
- Экспорт в PDF при желании
- щелчок правой кнопкой мыши на функции "отправить в onenote" повысил ценность нашей документации.
- отслеживание правок
Это только некоторые из особенностей. Для нас на самом деле слишком много преимуществ.