Как лучше сделать документацию компании?

Есть куча ворд файлов с инструкциями для сотрудников компании, всякими примерами кода и комментариями.
Надо все это сделать в вебе, в виде удобной документации с навигацией и прочим.
Как лучше это сделать? Я думаю все это обернуть в бутстрап классы, а дальше оно само красиво встанет.
Кто сталкивался с этим, как лучше это сделать?
  • Вопрос задан
  • 1565 просмотров
Решения вопроса 2
eduardtibet
@eduardtibet
Technical Writer / Documentation Engineer
ya39

Чтобы не выбрать неверное решение, вам сначала надо четко сформулировать для себя ответы на несколько вопросов. На тостере были подобные темы, и я отвечал на них. Начать надо отсюда: Какой инструмент документирования подойдет?

И потом внимательно изучить вот этот материал:
1. Как документировать существующее решение?
2. Кто должен составлять документацию ( в компании) на программный продукт?
3. На каком движке лучше сделать справочник по API?
4. Какие вы знаете сервисы для создания структурной документации проекта?
5. С помощью чего удобнее разрабатывать книгу (документацию) группой людей?
6. Какие есть сервисы для документации при разработке программ?
7. Как Вы документируете функционал приложения?
8. Какие общепринятые принципы формирования электронных документов вам известны?
9. Какой движок использовать для ведения документации по программе?
Ответ написан
HeadOnFire
@HeadOnFire
PHP, Laravel & WordPress Evangelist
Для подобных задач давным давно существует замечательное решение под названием Confluence.
Ответ написан
Пригласить эксперта
Ответы на вопрос 2
OTCloud
@OTCloud
- И как назовемся? Пожиратели пожирателей смерти?
Если нет определенных, описанных условий для реализации , то берите бутстрап и в вперед, иначе можно взять только сетку того же бутстрапа.
Ответ написан
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы