Skip to content

Documentation templates for fun and profit

Photo of Clarence Cromwell
Hosted By
Clarence C. and 4 others
Documentation templates for fun and profit

Details

Erin McKean will speak about templates for documentation and her activities with The Good Docs Project, a group that aims to create templates for building or improving all sorts of documentation.

We have a three-part plan:

1.) Erin will discuss the following:

  • What is The Good Docs Project
  • How do templates improve documentation?
  • What is the minimum viable docset?

2.)There will be a Q&A session for attendees who want to ask further questions.

3.) Erin would like to ask you some questions:

  • Do you want to share links to your favorite web resources about how to do documentation?
  • Do you want to share links to your favorite examples of documentation?
  • What types of projects might you need a minimum viable docset for?
  • Would you have ideas about what the Minimum Viable Docset should be for those projects?

Speak up if you would like to have help from The Good Docs Project to assess your documentation project after this event. (You can mention this in the Google form or speak up during the meeting.)

To RSVP provide us your email and check out the optional questions in our Google form:
https://forms.gle/y1U15r2M9L5Mvd5H9

RSVPs will close at 6:30 p.m. on the day before the event.

We'll send you the Zoom link before the meeting.

OUR SPEAKER:
Erin McKean is the Docs Advocacy Program Manager in the Open Source Programs Office at Google. You may also know her as the founder of the not-for-profit Wordnik.com, the world’s biggest online dictionary. Before founding Wordnik, she was the editor-in-chief of American Dictionaries for Oxford University Press, and before Javascript, she dabbled in HyperCard, Perl, and Omnimark (if you have ever written anything in Omnimark, she will buy you a drink). In addition to writing code, blog posts, and documentation, she’s also the author of the Weird and Wonderful Words books, the best-selling novel The Secret Lives of Dresses, and The Hundred Dresses, a field guide to dresses, and is an honorary fellow of the Society for Technical Communication. She blogs at dressaday.com. When you meet her, please tell her your favorite word.

PROGRAM:
6:00 p.m. GreetingsSocialize and network
6:15 p.m. Announcements/Introductions
6:30 p.m. Presentation, followed by questions and answers
7:30 p.m. Closing announcements/job postings/
7:35 Informal conversation
8 p.m. Lights out

-TRANSIT:
Stand up from your desk. Turn around three times, and say "There's no place like home."
Then click on the Zoom link, which will be provided here before the meeting.
This meetup will be 100 percent virtual.

Photo of Write the Docs Bay Area group
Write the Docs Bay Area
See more events