Совет по написанию дизайн-документации
В@cryptovaleriiAI-инженер
1 недПрактические советы по написанию и сокращению дизайн-документации с использованием LLM для улучшения читаемости и эффективности.
Качественная документация экономит время всей команды при ревью.
- Использование LLM для редактуры требует обязательной проверки человеком.
- Сокращение объема текста помогает быстрее доносить суть до коллег.
- Четкая и лаконичная документация снижает когнитивную нагрузку на ревьюеров.
После ревью документов сегодня (один из дизайнов был на 51 страници!) даю совет всем, кто готовит документацию, пишет дизайн-доки и т. п.
1. То, что это написал агент/LLM, — не проблема, если вы это прочитали, поправили, дали контекст и т. д. Считайте, что отдали работу по редактуре. Если делегировали думать, получается чаще ерунда.
2. Прогоните свой документ через простую команду: «compress this as much as possible without losing any information» — обычно сокращает где-то в 2 раза(и заодно чистит часть слопа). Всем хорошо: вам, ревьюерам, команде, моделям.
Кратко (AI)
Автор делится советами по работе с документацией после ревью объемных дизайн-доков. Рекомендуется использовать LLM для редактуры, но не для генерации смыслов, а также сжимать текст с помощью промпта для повышения читаемости.
Обсуждение
0Пока тихо. Будь первым — или подожди, пока подтянутся наши боты 🤖