Best practice templates and writing instructions for documenting open source software

The Internet
Joined July 2019
The Good Docs Project retweeted
If you write documentation, watch this now!! Cannot count the number of times your library/API/framework docs have had me spreading jam on a plate.
Today Year 2 learnt the importance of making instructions really clear and easy to follow. Who knew making a jam sandwich would be so difficult?🤷🏼‍♀️🥪 #instructions #Year2
Show this thread
8
68
194
The Good Docs Project retweeted
I love this! Working on the project itself is as important as writing the code for it. I cannot say how much I appreciate seeing documentation updates, reporting of issues, triaging of issues, reviewing of PRs and all the other things that need to be done on a project.
Added a CONTRIBUTING file to one of my favourite projects today (@rst2pdf of course) using this template from @PurpleBooth gist.github.com/PurpleBooth/… - if you're preparing your repos for #hacktoberfest, this could be a good resource for you too!
0
6
7
The Good Docs Project retweeted
Threw together resource links and notes from the Writing Day session about The Good Docs Project here, for people interested in templates, linters, style guides, and more: dev.to/scriptautomate/writet… #writethedocs
1
1
1
The Good Docs Project retweeted
HEY TECH WRITERS If you're making a style guide for your docs, put accessibility and inclusivity guidelines in it! We can eradicate all the "hands on" exercises, the "rules of thumb," the "see this topic" links. Inclusive docs are good for everyone and enforcing them is FREE.
2
41
111
Show this thread
The Good Docs Project retweeted
We've been working on a Sphinx extension that lets you write Sphinx docs in 💯 markdown (incl. roles and directives). We call it "MyST Markdown" (for "Markedly Structured Text"). Give it a shot, and please give feedback! myst-parser.readthedocs.io/e…
13
99
308
The Good Docs Project retweeted
Don't use markdown for documentation mister-gold.pro/posts/en/asc…
4
9
48
The Good Docs Project retweeted
🚀ANNOUNCEMENT🚀 The Developer’s Guide to Content Creation is NOW ON SALE 🎊 You’ll get: ✅100+ pages of content ✅14 worksheets ✅17 guided exercises ✅Real-world examples, tips, & LOTS of resources Available in PDF, ePUB, & mobi formats📕 Buy now: developersguidetocontent.com
27
129
375
Show this thread
The Good Docs Project retweeted
Great article on the good bad & ugly of API docs from the consumers' POV. The best APIs are designed with consumers & documentarians in mind, ISO (in Stoplight's opinion). "Best Practices for Navigating an API's Documentation" by @markmichon #DEVcommunity dev.to/bearer/best-practices…
0
12
18