Skip to content
This repository was archived by the owner on Aug 8, 2023. It is now read-only.

Commit 0812ad7

Browse files
committed
Merge pull request #84 from mobify/docs
Add documentation on writing documentation.
2 parents ca645e0 + 21fb5b6 commit 0812ad7

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

docs/README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
### Writing Checklist
2+
3+
**Before you start writing**
4+
5+
Write down the goal of your document.
6+
* Does a similar document exist? Could it be extended to meet the goal?
7+
* Does your document fit in an existing category? If so, which one?
8+
9+
Who is your audience? What is their skill level?
10+
11+
What kind of document best meets your goal?
12+
* [Step-by-step tutorials](https://jacobian.org/writing/what-to-write/#tutorials)
13+
* [Overview or topical guide to a conceptual area](https://jacobian.org/writing/what-to-write/#topical-guides)
14+
* [Low-level, deep-dive reference material](https://jacobian.org/writing/what-to-write/#reference)
15+
16+
**While writing**
17+
18+
* [Write like you talk](http://paulgraham.com/talk.html).
19+
* [Only use terms from the glossary](https://docs.google.com/document/d/1xbHkio-hdps-5zZG-SmmAKbR9WpXtrJJ-fprShN7NkM/edit).
20+
21+
**After writing**
22+
23+
* [ ] 👍 Reviewer
24+
* [ ] 🍻 Celeberate

0 commit comments

Comments
 (0)