Docs Best Practices

Best practices to write documents

Transcript

1. Я писать
2. Что использовать МС / Опен / Либре Офис Гугл Доки — не очень — норм Легко поделиться Легко вместе редактировать Трудно потерять Невозможно забыть
3. Текст
4. Заголовки Выделить жирным Поменять размер шрифта Изменить цвет — не очень
5. Заголовки Использовать настоящие заголовки — норм Делать разделы и подразделы — норм
6. Содержание Когда расставлены заголовки, можно добавить 1 2
7. Ссылки вовне Вставлять ссылку как текст — не очень Вставлять ссылку как ссылку — норм
8. Ссылки вовне Вставлять ссылку как ссылку — не очень Вставлять ссылку как часть текста — норм
9. Ссылки на разделы Ссылаться на разделы без ссылок — не очень
10. Ссылки на разделы Вставлять ссылки на разделы — норм 1 2
11. Списки Писать цифры и буллиты с клавиатуры — не очень
12. Списки Использовать настоящие списки — норм
13. Копи-паст Вставлять текст со стилями другого сайта — не очень
14. Копи-паст Вставлять текст без стилей — норм Option + ⌘ + Shift V
15. Вырвиглазным цветом — фу Читабельным цветом — лучше не надо Привлечение внимания Жирным и курсивом — норм www.artlebedev.ru/kovodstvo/sections/79/ ок, можно в художественных целях
16. Совместное использование
17. Когда дают почитать Делать правки прямо в тексте — не очень Предлагать правки — норм 1 2 и знаешь как лучше
18. Выделить цветом — не очень «То, что желтым выделено — фигня какая-то» Оставить коммент — норм 1 2 Когда дают почитать и не знаешь как лучше
19. Когда даешь почитать Если давать дописать раздел X — права на редактирование Если давать почтить и подтвердить — права на комментирование Если давать просто почтить — права на просмотр
20. Изображения
21. Пропорции Ломать пропорции — не очень
22. Пропорции Сохранять пропорции — норм
23. Пропорции Большие изображения можно загружать отдельно и давать на них ссылки
24. Рамки Вставлять белые изображения в белый документ — не очень
25. Рамки Задавать изображениям на белом фоне рамку — норм
26. Напоследок
27. Правописание Оставлять на совести читателей — не очень Проверять автоматически — норм
28. Скрипты Быть программистом и не стремиться программировать — не очень Использовать гугл-скрипты — норм
29. Заботьтесь о читателе ^__^