Skip to content

Vue Docs Writing Guide #2317

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Oct 24, 2019
Merged

Vue Docs Writing Guide #2317

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
0cb573b
add vue docs writing guide
chrisvfritz Sep 27, 2019
f0cba12
add note about emoji to writing guide
chrisvfritz Sep 30, 2019
93952ed
add note about invalidating language to writing guide
chrisvfritz Sep 30, 2019
50409b6
add note about blending tips into content in writing guide
chrisvfritz Sep 30, 2019
acaeb33
capitalize Oxford in writing guide
chrisvfritz Sep 30, 2019
8d860aa
reword feature discussions note in writing guide
chrisvfritz Sep 30, 2019
d23b6c4
clarify 'supported environment' in writing guide
chrisvfritz Sep 30, 2019
d9bdaaf
add software resources to writing guide
chrisvfritz Sep 30, 2019
3bf20dc
clarify language in writing guide
chrisvfritz Sep 30, 2019
b4827c8
clarify language in writing guide
chrisvfritz Sep 30, 2019
62ccb2d
pull oxford comma image into repo
chrisvfritz Sep 30, 2019
94db5b7
add note about allowing abbreviation symbols on keyboards
chrisvfritz Oct 1, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
add software resources to writing guide
  • Loading branch information
@chrisvfritz
chrisvfritz committed Sep 30, 2019
commit d9bdaaf30e24bc5fc384b1f23e3c4c712fe70436
13 changes: 10 additions & 3 deletions writing-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,13 @@ Writing documentation is an exercise in empathy. We're not describing an objecti

## Resources

- Book: [On Writing Well](https://www.amazon.com/Writing-Well-30th-Anniversary-Nonfiction-ebook/dp/B0090RVGW0) (see [popular quotes](https://www.goodreads.com/work/quotes/1139032-on-writing-well-the-classic-guide-to-writing-nonfiction))
- Book: [Bird by Bird](https://www.amazon.com/Bird-Some-Instructions-Writing-Life/dp/0385480016) (see [popular quotes](https://www.goodreads.com/work/quotes/841198-bird-by-bird-some-instructions-on-writing-and-life))
- Book: [Cognitive Load Theory](https://www.amazon.com/Cognitive-Explorations-Instructional-Performance-Technologies/dp/144198125X/)
### Software

- [Grammarly](https://www.grammarly.com/): Desktop app and browser extension for checking spelling and grammar (though grammar checking doesn't catch everything and occasionally shows a false positive).
- [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker): An extension for VS Code to help you check spelling within markdown and code examples.

### Books

- [On Writing Well](https://www.amazon.com/Writing-Well-30th-Anniversary-Nonfiction-ebook/dp/B0090RVGW0) (see [popular quotes](https://www.goodreads.com/work/quotes/1139032-on-writing-well-the-classic-guide-to-writing-nonfiction))
- [Bird by Bird](https://www.amazon.com/Bird-Some-Instructions-Writing-Life/dp/0385480016) (see [popular quotes](https://www.goodreads.com/work/quotes/841198-bird-by-bird-some-instructions-on-writing-and-life))
- [Cognitive Load Theory](https://www.amazon.com/Cognitive-Explorations-Instructional-Performance-Technologies/dp/144198125X/)