Главная Юзердоски Каталог Трекер NSFW Настройки

Программирование

Ответить в тред Ответить в тред
Check this out!
<<
Назад | Вниз | Каталог | Обновить | Автообновление | 5 1 3
Как писать хорошие документации Аноним 22/12/25 Пнд 14:27:04 3610211 1
Manual.jpg 17Кб, 178x259
178x259
Хочу научиться писать понятные инструкции/документации/мануалы, ищу внезапные решения, может быть лучшие практики. Если что тред не ограничивается ЯП-ми, но кого если не программиста спрашивать как писать упорядоченные действия.

Вот некоторые советы, которые звучат как база:
- Тостировать свои инструкции, воссоздавая с нуля
- использовать рекурсивные уточнения
- представлять себя в роли человека, которому придётся читать
- заранее продумывать TL;DR и FAQ
- описывать только то, что есть (без загадывания)
- избыточность и уточнение очевидных пунктов
- не пропускать пункты, даже если они повторяются
- картинка > текста (Снег > текста)


Пишите свои дополнения к этому списку или просто хорошие практики.
Аноним 22/12/25 Пнд 16:38:31 3610309 2
Нах самому писать, дух рождества с этим прекрасно справляется
Аноним 23/12/25 Втр 12:32:30 3610843 3
Загугли MANUFACTURER’S GUIDE TO DEVELOPING CONSUMER PRODUCT INSTRUCTIONS
Аноним 25/12/25 Чтв 14:56:59 3612270 4
бамп
25/12/25 Чтв 15:15:19 3612280 5
Хуямп.
Настройки X
Ответить в тред X
15000
Добавить файл/ctrl-v
Стикеры X
Избранное / Топ тредов