Все сервисы Хабра
Сообщество IT-специалистов
Ответы на любые вопросы об IT
Профессиональное развитие в IT
Закрыть
Задать вопрос
Сергей Нижний Новгород
@Terras
Документация
Есть ли какие-то книги, статьи по тому, как правильно писать документацию?
Есть ли какие-то книги, статьи, мнение экспертов по тому, как в идеале должна выглядеть документация большого проекта?
Вопрос задан
более трёх лет назад
70 просмотров
Комментировать
Подписаться
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
Ваш ответ на вопрос
Войдите, чтобы написать ответ
Войти через центр авторизации
Похожие вопросы
Python
+1 ещё
Простой
Какие существуют средства автодокументации кода Python для недокументированного кода?
1 подписчик
05 окт. 2024
153 просмотра
2
ответа
Android
+2 ещё
Простой
Как делать поиск по содержимому файлов(документов) на Android'е?
2 подписчика
27 сент. 2024
154 просмотра
1
ответ
Python
+3 ещё
Простой
Как менять регистр букв в контексте при слиянии через docxtpl + openpyxl?
2 подписчика
26 сент. 2024
94 просмотра
0
ответов
Фреймворки
+1 ещё
Простой
На каком фреймворке написана документация laravel?
5 подписчиков
02 авг. 2024
831 просмотр
1
ответ
Документация
+1 ещё
Простой
Какие средства есть индексации документации docx\pdf?
1 подписчик
05 июл. 2024
87 просмотров
1
ответ
Проектирование программного обеспечения
+1 ещё
Простой
Есть ли языки/нотации для записи бизнес-логики?
3 подписчика
05 июл. 2024
1675 просмотров
4
ответа
C#
+2 ещё
Средний
Возникла ошибка в примерах от LLamaSharp?
3 подписчика
18 июн. 2024
300 просмотров
2
ответа
Документация
Средний
Какие есть .exe агрегаторы документации?
1 подписчик
28 мая 2024
66 просмотров
0
ответов
Документация
Средний
Как удобно вести матрицу межсерверных взаимодействий?
2 подписчика
02 апр. 2024
116 просмотров
0
ответов
Процессоры
+2 ещё
Средний
Документация по процессору Intel Pentium 4 socket 478?
1 подписчик
14 мар. 2024
198 просмотров
1
ответ
Показать ещё
Загружается…
Вакансии с Хабр Карьеры
Инженер по голосовой коммутации (инженер CS Core)
Quickly Search
•
Москва
от 200 000 до 300 000 ₽
Technical Writer
Conjointly
•
Бангкок
от 1 000 до 2 000 ₽
Технический писатель
Связь и Радионавигация
•
Санкт-Петербург
от 90 000 ₽
Минуточку внимания
Войдите на сайт
Чтобы задать вопрос и получить на него квалифицированный ответ.
Войти через центр авторизации
Закрыть
Реклама