Best practice templates and writing instructions for documenting open source software

The Internet
Joined July 2019
The Good Docs Project retweeted
Writing Day at the @writethedocs Portland is in full swing. 14 projects to choose from, to document, to discuss, to chat about. #techcom #writethedocs – at Portland, OR
1
3
16
1,669
The Good Docs Project retweeted
'A crucial part of launching a successful open source project is cultivating a healthy contributor community. Maintainers can sow the seeds for success by highlighting ways people can become involved in and grow within a project.' – with @juliaferraioli bit.ly/3rtInMk
4
8
The Good Docs Project retweeted
Thank you again to everyone who made the 2022 Prague conference amazing! Talk videos are published on YouTube, sketchnotes are published on Flickr, and shirts are still on sale until the end of the month. Details in the blog post: writethedocs.org/conf/prague… #writethedocs
8
2
22
The Good Docs Project retweeted
For #opensource organizers looking to improve their comms with sponsors, I put together a toolkit including suggestions and templates for: - sponsorship prospectus - event report (one-time sponsor) - annual report (ongoing sponsor) github.com/google/opendocs/t…
7
14
5
47
The Good Docs Project retweeted
We just shipped our August community update: * Starting 2023 conference planning * Changes coming to Slack & thanks to our mod team * Salary survey is around the corner * Prague (tickets!) & Australia (CFP!) coming soon writethedocs.org/blog/2022-c…
1
7
The Good Docs Project retweeted
And what are you standing on? #techwritingmemes #memeday
3
1
14
The Good Docs Project retweeted
Prague update: We're excited to announce the full list of talks and speakers! Thank you again to all who submitted proposals. Other updates include: Shirts are now on sale and the grant program is still open. Details in the blog post: writethedocs.org/conf/prague… #writethedocs
4
4
13
The Good Docs Project retweeted
Now that we’ve had a chance to rest after Portland, it's time to resume preparations for Prague! Tickets are on sale, the full website is live, and the CFP is open until the end of June. Details in the blog post: writethedocs.org/conf/prague… #writethedocs
6
7
The Good Docs Project retweeted
Welcome to Write the Docs Portland Writing Day! Introduction is underway in the Sessions area and then we team up and start writing! Information about Writing Day here: writethedocs.org/conf/portla… #writethedocs
2
3
The Good Docs Project retweeted
The integrated schedule for Write the Docs Portland Writing Day is here: bit.ly/wtd-pdx-2022-ro @writethedocs
1
2
The Good Docs Project retweeted
Thanks to everyone who attended! We got some excellent feedback 😄 #writethedocs
Happening now! our #writethedocs Portland session: Identifying content types for templates! Table 2. Join us!
1
2
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
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…
11
73
14
249
The Good Docs Project retweeted
Don't use markdown for documentation mister-gold.pro/posts/en/asc…
2
9
1
45