Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
Docs Best Practices
Search
Daniel Kocherga
August 01, 2014
Business
1
240
Docs Best Practices
Best practices to write documents
Daniel Kocherga
August 01, 2014
Tweet
Share
Other Decks in Business
See All in Business
【DearOne】Dear Newest Member
hrm
1
2.1k
エムスリーキャリア エンジニア採用資料 / M3C Engineer Guide
m3c
1
76k
GitHubを使わずDatabricksだけで お手軽にライブラリ共有やCIが できる環境を作ってみた/Creating an Environment for Easy Library Sharing and CI Using Only Databricks Without GitHub
kakehashi
1
300
株式会社人機一体 + 会社紹介資料 + 2024.04.01 版
mmse
0
410
アジャイルトランスフォーメーションが現場にもたらす価値と超えるべきいくつかの壁/Agile transformation and some impediments
ikuodanaka
4
650
しくじり先生 〜ふりかえり手法はチームのイマとコネクトして〜
electricsatie
0
320
おひさぽ ご説明資料
trinitytechnology
0
51k
Beyond Engineering: The Future of Platforms
mfpais
PRO
1
270
akippa株式会社 - 会社紹介資料
akippa
2
44k
ちゅらデータ会社紹介資料 / ChuraDATA Introduction
churadata
0
630
社会変化兆候調査 vol.17 / 132 global changes in lifestyle 2024 vol.17
nozomi
0
160
HRBrain|26卒 新卒向け|会社説明資料
hrbrain
2
270
Featured
See All Featured
Side Projects
sachag
451
41k
From Idea to $5000 a Month in 5 Months
shpigford
377
45k
The Pragmatic Product Professional
lauravandoore
24
5.8k
Building Adaptive Systems
keathley
30
1.9k
4 Signs Your Business is Dying
shpigford
175
21k
The Brand Is Dead. Long Live the Brand.
mthomps
48
28k
Scaling GitHub
holman
457
140k
Navigating Team Friction
lara
177
13k
ピンチをチャンスに:未来をつくるプロダクトロードマップ #pmconf2020
aki_iinuma
77
42k
The MySQL Ecosystem @ GitHub 2015
samlambert
242
12k
Web development in the modern age
philhawksworth
202
10k
JavaScript: Past, Present, and Future - NDC Porto 2020
reverentgeek
39
4.4k
Transcript
Я писать
Что использовать МС / Опен / Либре Офис Гугл Доки
— не очень — норм Легко поделиться Легко вместе редактировать Трудно потерять Невозможно забыть
Текст
Заголовки Выделить жирным Поменять размер шрифта Изменить цвет — не
очень
Заголовки Использовать настоящие заголовки — норм Делать разделы и подразделы
— норм
Содержание Когда расставлены заголовки, можно добавить 1 2
Ссылки вовне Вставлять ссылку как текст — не очень Вставлять
ссылку как ссылку — норм
Ссылки вовне Вставлять ссылку как ссылку — не очень Вставлять
ссылку как часть текста — норм
Ссылки на разделы Ссылаться на разделы без ссылок — не
очень
Ссылки на разделы Вставлять ссылки на разделы — норм 1
2
Списки Писать цифры и буллиты с клавиатуры — не очень
Списки Использовать настоящие списки — норм
Копи-паст Вставлять текст со стилями другого сайта — не очень
Копи-паст Вставлять текст без стилей — норм Option + ⌘
+ Shift V
Вырвиглазным цветом — фу Читабельным цветом — лучше не надо
Привлечение внимания Жирным и курсивом — норм www.artlebedev.ru/kovodstvo/sections/79/ ок, можно в художественных целях
Совместное использование
Когда дают почитать Делать правки прямо в тексте — не
очень Предлагать правки — норм 1 2 и знаешь как лучше
Выделить цветом — не очень «То, что желтым выделено —
фигня какая-то» Оставить коммент — норм 1 2 Когда дают почитать и не знаешь как лучше
Когда даешь почитать Если давать дописать раздел X — права
на редактирование Если давать почтить и подтвердить — права на комментирование Если давать просто почтить — права на просмотр
Изображения
Пропорции Ломать пропорции — не очень
Пропорции Сохранять пропорции — норм
Пропорции Большие изображения можно загружать отдельно и давать на них
ссылки
Рамки Вставлять белые изображения в белый документ — не очень
Рамки Задавать изображениям на белом фоне рамку — норм
Напоследок
Правописание Оставлять на совести читателей — не очень Проверять автоматически
— норм
Скрипты Быть программистом и не стремиться программировать — не очень
Использовать гугл-скрипты — норм
Заботьтесь о читателе ^__^