Все сервисы Хабра
Сообщество IT-специалистов
Ответы на любые вопросы об IT
Профессиональное развитие в IT
Закрыть
Задать вопрос
Сергей Нижний Новгород
@Terras
Документация
Есть ли какие-то книги, статьи по тому, как правильно писать документацию?
Есть ли какие-то книги, статьи, мнение экспертов по тому, как в идеале должна выглядеть документация большого проекта?
Вопрос задан
более трёх лет назад
73 просмотра
Комментировать
Подписаться
1
Средний
Комментировать
Facebook
Вконтакте
Twitter
Решения вопроса
0
Пригласить эксперта
Ответы на вопрос
2
Александр
@NeiroNx
Программист
Есть ГОСТы
gostexpert.ru/oks/35/80?page=1#listGosts
Если бы у вас было высшее образование вы бы это знали, может еще не поздно получить?
начать надо с ГОСТ 19.001-77 Общие положения ЕСПД
Ответ написан
более трёх лет назад
1
комментарий
Нравится
1
комментарий
Facebook
Вконтакте
Twitter
Сергей Нижний Новгород
@Terras
Автор вопроса
Я не госты, я про то, как структуризировать доку по проекту, чтобы это потом не превратилось в неподдерживаемый мусор
Написано
более трёх лет назад
Эдуард Тибет
@eduardtibet
Technical Writer / Documentation Engineer
Начинаем отсюда:
Как и где хранить техническую документацию?
(пусть вас не смущает название темы) и читаем, читаем, читаем. На очень многие вопросы уже отвечено.
Ответ написан
более трёх лет назад
Комментировать
Нравится
Комментировать
Facebook
Вконтакте
Twitter
Ваш ответ на вопрос
Войдите, чтобы написать ответ
Войти через центр авторизации
Похожие вопросы
Документация
+1 ещё
Средний
В каком виде правильно представлять отчетную документацию при создании информационной системы?
1 подписчик
21 июн.
79 просмотров
1
ответ
Python
+1 ещё
Простой
Какие существуют средства автодокументации кода Python для недокументированного кода?
1 подписчик
более года назад
199 просмотров
2
ответа
Android
+2 ещё
Простой
Как делать поиск по содержимому файлов(документов) на Android'е?
2 подписчика
более года назад
273 просмотра
1
ответ
Python
+3 ещё
Простой
Как менять регистр букв в контексте при слиянии через docxtpl + openpyxl?
2 подписчика
более года назад
103 просмотра
0
ответов
Фреймворки
+1 ещё
Простой
На каком фреймворке написана документация laravel?
5 подписчиков
более года назад
856 просмотров
1
ответ
Документация
+1 ещё
Простой
Какие средства есть индексации документации docx\pdf?
1 подписчик
более года назад
110 просмотров
1
ответ
Проектирование программного обеспечения
+1 ещё
Простой
Есть ли языки/нотации для записи бизнес-логики?
3 подписчика
более года назад
1682 просмотра
4
ответа
C#
+2 ещё
Средний
Возникла ошибка в примерах от LLamaSharp?
3 подписчика
более года назад
315 просмотров
2
ответа
Документация
Средний
Какие есть .exe агрегаторы документации?
1 подписчик
более года назад
71 просмотр
0
ответов
Документация
Средний
Как удобно вести матрицу межсерверных взаимодействий?
2 подписчика
более года назад
125 просмотров
0
ответов
Показать ещё
Загружается…
Вакансии с Хабр Карьеры
Помощник главного инженера проекта (подстанции)
ЭЛСИ Энергопроект
•
Новосибирск
от 120 000 ₽
Системный аналитик (Мои Сервисы)
Сбер
•
Москва
от 300 000 ₽
Engineer — process automation
SMALL
от 300 000 до 400 000 ₽
Минуточку внимания
Войдите на сайт
Чтобы задать вопрос и получить на него квалифицированный ответ.
Войти через центр авторизации
Закрыть
Реклама