Skip to content
Snippets Groups Projects
Commit c4dfb068 authored by Alyssa Rock's avatar Alyssa Rock
Browse files

Update working groups

parent 37229508
Branches
No related tags found
1 merge request!227Update working groups
Showing with 95 additions and 251 deletions
......@@ -6,18 +6,41 @@ draft: false
{{% blocks/lead color="primary" %}}
# The Good Docs Project Working Groups
# The Good Docs Project working groups
Working Groups are formed by volunteers who coalesce around goals or a collection of projects that we think will benefit the community.
Please see the details for each working group below to see where you can help.
Learn more about The Good Docs Project working groups and join one today!
{{% /blocks/lead %}}
{{% blocks/section color="white" type="section" %}}
A working group consists of two or more templateers who are collaborating together to work on a Good Docs Project initiative or focus area of the project.
Working groups can be organized on a temporary, ad-hoc basis or can exist as a long-term, permanent basis as long as there is sufficient interest to maintain them.
All working groups are open for anyone to join as a general rule.
Contributors can belong to as many working groups as they have time for and it’s okay to join a group to observe for a while before contributing.
If you are interested in contributing to a working group, join their Slack channel to ask how you can get involved.
## What are working groups?
A working group consists of two or more project contributors who are collaborating together to work on a Good Docs Project initiative or focus area of the project.
## Who can join?
If you are new to The Good Docs Project, begin by filling out the [Welcome Wagon registration form](https://thegooddocsproject.dev/welcome/) to receive an invitation to the project.
After you've joined the project, all working groups are open for anyone to join as a general rule. Contributors can belong to as many working groups as they have time for and it’s okay to join a group to observe for a while before contributing.
If you are interested in contributing to a working group:
- Talk to the working group lead(s)
- Join the working group Slack channel (channel names are in the group's description page)
- Check the [community calendar](https://thegooddocsproject.dev/community/#calendar) for meeting times and join a meeting
## What is the time commitment?
The various working groups generally meet weekly or bi-weekly for an hour.
Most community members give about 1-2 hours of their time every week by participating in one of these groups.
Always remember that we’ll take what you can give. You and your family come first, then work, then volunteering.
If you can’t keep your working group commitments, that’s okay. Just let your working group leader know.
## Which working groups are available?
Click any of the working groups below to learn more about what that group is working on.
{{% /blocks/section %}}
\ No newline at end of file
---
title: Business Case Working Group
poc: "[Cameron Shorter](https://thegooddocs.slack.com/team/UKTGLQNGG)"
meeting: Mondays at 12:00 p.m. Pacific Time, California (on Google Meet).
status: Active
description: Discover the optimal information for a documentation business case, and provide materials that help people make their own and succeed.
slackName: business-case
slackID: C02PQLCCFS6
notesURL: https://docs.google.com/document/d/1MKWdkbRmofahq884WjsopMCao-IA51ZcqrF_NwLDkDQ/edit#
members:
- "[cameronshorter](https://thegooddocs.slack.com/team/UKTGLQNGG)"
- "[Jarek Piotrowski](https://thegooddocs.slack.com/team/U02HHG38AH0)"
- "[Karissa Van Baulen](https://thegooddocs.slack.com/team/U02C0SJ11PW)"
- "[felicitybrand](https://thegooddocs.slack.com/team/UKV4ZPEFQ)"
- "[Nidia Trejo](https://thegooddocs.slack.com/team/U02R6SXEGRG)"
- "[Rob Beg](https://thegooddocs.slack.com/team/U02FPRE1STA)"
- "[Tina Lüdtke](https://thegooddocs.slack.com/team/U02EQQDFLE8)"
- "[Edwin Dawson](https://thegooddocs.slack.com/team/U02TU5SQUPK)"
- "[Kit Brown-Hoekstra](https://thegooddocs.slack.com/team/U02M65D4C7M)"
- "[macklin](https://thegooddocs.slack.com/team/U01DYRWG43X)"
draft: false
---
In industry, we often find ourselves arguing for greater investment in documentation.
We aim to discover the optimal information that could be used for a documentation business case, then create materials that help people make their own business case supporting documentation investment.
We are identifying key statistics and metrics used by business decision makers, that could be used to support a proposal for increasing docs investment.
---
title: Chronologue Working Group
poc: "[Tina Lüdtke](https://thegooddocs.slack.com/team/U02EQQDFLE8)"
meeting: Saturdays 12 pm (Pacific time).
title: Chronologue
leads:
- "Valeria Hernandez"
meeting: Saturdays - Check time on [Community calendar](https://thegooddocsproject.dev/community/#calendar)
status: Active
description: The Chronologue is a fictional example software project to illustrate what
good documentation looks like. We're on a mission to avoid 'foo' and 'bar', so
we're writing real, contextual examples for use by The Good Docs and other
projects.
description: Acts as quality assurance by testing the Good Docs templates and creating high-quality examples of our templates for the Chronologue mock tool.
slackName: chronologue-docs
slackID: C016L3962CU
notesURL: https://docs.google.com/document/d/1Pr8ncPr2qAnwE4umr4lFVRiUhBGM1n8wESKgrz2YEoo/edit?usp=sharing
members:
- "[Tina Lüdtke - Working group captain](https://thegooddocs.slack.com/team/U02EQQDFLE8)"
- "[Ian - API designer](https://github.com/fineon)"
- "[Serena Jolley - UX designer](https://thegooddocs.slack.com/team/U02FZSBAHTM)"
- "[Ulises de la Luz - UX designer](https://thegooddocs.slack.com/team/U02FD2KEQ0L)"
- "[Bryan Klein - Doc tools](https://thegooddocs.slack.com/team/U018BJR6JQN)"
- "[Alyssa Rock - Technical writer](https://thegooddocs.slack.com/team/U012KCMPP0V)"
- "[Valeria Hernandez - Technical writer](https://thegooddocs.slack.com/team/U03H69W13C0)"
- "[Richard Foote - Technical writer](https://thegooddocs.slack.com/team/U03EZT8QSHJ)"
- "[Peter Jurich - Technical writer](https://thegooddocs.slack.com/team/U03GGGLL31Q)"
- "[Erin McKean - Technical writer & initiator](https://thegooddocs.slack.com/team/UL2AA1FF1)"
- "[Felicity Brand - Technical writer](https://thegooddocs.slack.com/team/UKV4ZPEFQ)"
draft: false
lastmod: 2022-07-13T16:52:41.181Z
---
Examples are good.
They help templateers demonstrate how a template works and they help readers understand a complex concept.
We want to avoid using 'foo' and 'bar' - the Lorem Ipsum of code placeholders.
We're working to create a fake software product: The Chronologue.
The Chronologue is a fictional telescope that can look into the past, and make predictions for the future, too.
Users can watch pre-rendered events on a website, or submit requests for new events to be recorded.
The Chronologue is mock tool that needs your help to document it! It's a telescope that uses wormhole technology to view astronomical events at any point in the past, present, or future.
What we've already done so far:
- Prototyping user journeys and wireframes
- Specifying an API to retrieve data
The goal of the Chronologue is to document a mock tool to create an example of what good documentation looks like.
What we're currently up to:
- Building a prototype of a website
- Writing the first set of documentation
We have a strong need for team members to help us test our templates, create examples of effective documentation, and improve the overall quality of our templates.
It doesn’t matter if you have a writing background or not since we intend our templates to be used by people from a variety of backgrounds.
Our goal is serve as an example that templateers and documentarians can use to demonstrate what good docs look like.
Everyone is welcome to come and play with us.
If you have development skills, we can also use your help developing our fake tool!
Be aware that this working group is difficult to join if you are in the APAC region because this working group currently doesn’t meet at APAC friendly times yet.
If you are in the APAC region, let us know and we’ll consider setting up new times based on how many people are interested.
\ No newline at end of file
---
title: Community Docs
poc: "[Deanna](https://thegooddocs.slack.com/team/U01SXR5TKA6)"
meeting: Thursdays at 4:00p Mountain time (UTC-6)
status: Active
description: Creating high-quality templates for the core sets of community docs that are necessary for the health, productivity, and cross-coordination of open source communities.
slackName: community-docs
slackID: C01R89CRWCR
notesURL: https://docs.google.com/document/d/1iRxB0T7FoVjIeG_LawbCzcLfXCILlpFdzn-4BPDGR9Y/edit?usp=sharing
members:
- "[Alyssa Rock](https://thegooddocs.slack.com/team/U012KCMPP0V)"
- "[Carrie Crowe](https://thegooddocs.slack.com/team/U01QS8YAHHN)"
- "[Deanna](https://thegooddocs.slack.com/team/U01SXR5TKA6)"
- "[Joanne Fung](https://thegooddocs.slack.com/team/U02PXJYC747)"
- "[Kayla Morales](https://thegooddocs.slack.com/team/U02F7ECFCDQ)"
- "[Rob](https://thegooddocs.slack.com/team/U02FPRE1STA)"
- "[Sameera](https://thegooddocs.slack.com/team/U031XUE6KQC)"
draft: false
---
Every open source community should have some core community documentation like a good README, Contributing Guide, PR and issue templates, Code of Conduct, RFCs, and more.
This working group is collaborating together to provide high-quality templates and best practices for the types of documentation your project needs to attract and retain active contributors.
If you're passionate about creating healthy open source communities and ensuring everyone who joins a community can find a meaningful way to start contributing as soon as possible, then this is the working group for you!
---
title: Content Strategy
poc: "[Carrie Crowe](https://thegooddocs.slack.com/team/U01QS8YAHHN)"
meeting: TBD
title: Content strategy
leads:
- "Carrie Wattula"
- "Felicity Brand"
meeting: Thursdays (US)/Fridays (APAC) - Check time on [Community calendar](https://thegooddocsproject.dev/community/#calendar)
status: Active
description: Collaborating to create the overall content strategy for the Good Docs project.
description: Collaborates about the overall content and UX strategy for the Good Docs project across all communication channels, including our website, social media, internal knowledge base, and blog.
slackName: content-strategy
slackID: C023G344YAJ
notesURL: https://docs.google.com/document/d/1x6SExdCncsbRb3XMUYyshXcPo5OIFxT81fvComNJjkc/edit?usp=sharing
members:
- "[Aidan Doherty](https://thegooddocs.slack.com/team/U019868JEQ0)"
- "[Alyssa Rock](https://thegooddocs.slack.com/team/U012KCMPP0V)"
- "[Bryan Klein](https://thegooddocs.slack.com/team/U018BJR6JQN)"
- "[Cameron Shorter](https://thegooddocs.slack.com/team/UKTGLQNGG)"
- "[Carrie Crowe](https://thegooddocs.slack.com/team/U01QS8YAHHN)"
- "[Ryan Macklin](https://thegooddocs.slack.com/team/U01DYRWG43X)"
draft: false
---
The Content Strategy working group ensures that the content on our various communication channels supports our project's objectives and meets the needs of our contributors, users, and followers.
The Content strategy working group ensures that the content on our various communication channels supports our project's objectives and meets the needs of our contributors, users, and followers.
This group's will work on defining users by monitoring site analytics or conducting user research, defining who will help create content and how, and develop our content lifecycle.
......
---
title: Docs Advocacy & Education
poc: "[Ryan Macklin](https://thegooddocs.slack.com/team/U01DYRWG43X)"
meeting: Floating meetings and working sessions at least twice a month
status: Active
description: Generating videos, blog entries, and other media to promote greater empathy for documentation readers and share best practices for documentation creators.
slackName: cafe-procope
slackID: C01SDNR5X1C
notesURL: http://bit.ly/gcp-procope-meeting
members:
- "[Felicity Brand](https://thegooddocs.slack.com/team/UKV4ZPEFQ)"
- "[Carrie Crowe](https://thegooddocs.slack.com/team/U01QS8YAHHN)"
- "[Bryan Klein](https://thegooddocs.slack.com/team/U018BJR6JQN)"
- "[Tina Lüdtke](https://thegooddocs.slack.com/team/U02EQQDFLE8)"
- "[Ryan Macklin](https://thegooddocs.slack.com/team/U01DYRWG43X)"
- "[Aaron Peters](https://thegooddocs.slack.com/team/U013XPC8Q9Z)"
- "[Alyssa Rock](https://thegooddocs.slack.com/team/U012KCMPP0V)"
draft: false
---
Our group's mission statement: Educating the public on strong documentation philosophies and practices, to empower those who aren't primarily tech writers (and also those who are).
One part of improving docs in open source is getting buy-in from developers about why docs matter.
Another part is helping people interested in good documentation learn how to create it!
Join this group if you’re interested in working on blog entries, white papers, or any other kind of media that will promote documentation fundamentals and best practices. (We have ambitions for videos in the future.)
Our group's working model is largely distributed efforts to create content, brought together in review and scheduled by one of the lead publishers.
We're looking for people who want to offer doc advocacy and practices, or who want to learn those things and be involved with critiquing submitted content.
---
title: Doc Tools (Easy Button)
poc: "[Bryan Klein](https://thegooddocs.slack.com/team/U018BJR6JQN)"
meeting: TBD (Use Slack for Now)
title: Doc tools registry
leads:
- "Bryan Klein"
meeting: Bi-weekly on Thursdays (US)/Fridays (APAC) - Check time on [Community calendar](https://thegooddocsproject.dev/community/#calendar)
status: Active
description: Creating a Hugo/Docsy repository that can be easily cloned to set up a new documentation system for a project. Using the GDP Templates as archetypes for new content in the site.
slackName: doctools-easy-button
description: Creates a database of resources for doc tool tech stacks to help people decide which tools to use for their doc system.
slackName: doctools-registry
slackID: C01T803GT34
notesURL: https://docs.google.com/document/d/1zOn8WX1if8Bzk2yKmQtwnPU3QGqOzdDrtaa5x03Y2M0/edit?usp=sharing
members:
- "[Aaron Peters](https://thegooddocs.slack.com/team/U013XPC8Q9Z)"
- "[Aidan Doherty](https://thegooddocs.slack.com/team/U019868JEQ0)"
- "[Alyssa Rock](https://thegooddocs.slack.com/team/U012KCMPP0V)"
- "[Bryan Klein](https://thegooddocs.slack.com/team/U018BJR6JQN)"
- "[Derek Ardolf](https://thegooddocs.slack.com/team/U015GARCR8X)"
- "[Manasi Gandhi](https://thegooddocs.slack.com/team/U01UJBVJW4R)"
- "[Morgan Craft](https://thegooddocs.slack.com/team/U012Y26QWNA)"
- "[Nancy Hutson Hale](https://thegooddocs.slack.com/team/U01U8ALH1G8)"
- "[Rufai Mustapha](https://thegooddocs.slack.com/team/U01TYD2JSAH)"
draft: false
---
One of the biggest hurdles to creating good documentation is setting up your initial documentation toolchain.
Join this group to collaborate with our docs tool experts who are working on creating a Hugo/Docsy repository that can be easily cloned to set up a new documentation system for a project.
The example site included in the project will use the templates from the Good Docs Project for each content type.
Our primary goal is to provide a new documentation website starting point for anyone, almost instantly, with a single click of a button.
This group is researching the various tools that could be used in a documentation system to set up a new doc site or improve any existing one. The doc tools registry is building a database that allows you to filter the available tools based on your system requirements.
---
title: EMEA-APAC Templateers
poc: "[Cameron Shorter](https://thegooddocs.slack.com/team/UKTGLQNGG)"
meeting: Tuesday, 07:00 [UTC](https://www.timeanddate.com/time/aboututc.html)
status: Active
description: Templateers in EMEA and APAC timezones, supporting each other to create Good Doc templates.
slackName: emea-apac
slackID: C02BN136NF3
notesURL: https://docs.google.com/document/d/1p2fLUijtgfarkNxJTNK6PlkhCnKI--nP4beYCY1J-So
members:
- Cameron Shorter
- Ankita Tripathi
- Ati M
- Chris Ward (ChrisChincilla)
- Gayathri Krishnaswamy
- Karissa Van Baulen
- Nelson Guya
- Qian Lu (Choco)
- Viraji Ogodapola
draft: false
---
Tech writers who help each other develop doc templates for The Good Docs Project. We meet weekly and check in on each other's progress. We've picked a timezone for EMEA and APAC timezones:
* Morning (Europe/Africa)
* Day (India/Asia)
* Evening (Australia/Pacific)
---
title: Glossaries
poc: "[Cameron Shorter](https://thegooddocs.slack.com/team/UKTGLQNGG)"
meeting: Monthly on third Tuesdays of the month, at 7AM UTC (on Google Meet)
status: Active
description: Creating cross-organizational and inter-operable glossaries with a standardised format for terms and definitions.
slackName: glossaries
slackID: C019A1EQJMC
notesURL: https://docs.google.com/document/d/1yzncnQB7uYktPnAQ4DqZYVPDdYnqDrWmqHzcpXrjkPg/
members:
- "[Ankita Tripathi](https://thegooddocs.slack.com/team/D016LHJPDSR)"
- "[Cameron Shorter](https://thegooddocs.slack.com/team/UKTGLQNGG)"
- "[Codrina Maria Ilie](https://thegooddocs.slack.com/team/D01A8SW6CBX)"
- "[Reese W. Plews](https://thegooddocs.slack.com/archives/D019RSVPE69)"
- "[Rob Atkinson](https://thegooddocs.slack.com/team/U01DYRWG43X)"
draft: false
---
The goal of our community is to create a template for glossaries that can be easily integrated by anyone creating glossaries for their own project.
The pilot will build processes and tools for the generic use case, developing and applying them within the geospatial mapping domain.
* We plan to use the base template (a "template of templates") that we've created as the starting point to create a template for glossaries.
* We will establish processes for sharing terms between organizations and glossaries.
* We will create a process for a central glossary owner to accept, triage, and refine proposals for new terms from their community.
Our primary goal is to create glossaries for organizations like OSGeo, ESRI, or GRASS to hold them as examples using tools like Glossarist.
---
title: Onboarding
poc: "[Ankita Tripathi](https://thegooddocs.slack.com/archives/D016LHJPDSR)"
meeting: One to one interactions on Google meet or Emails or Slack channel
status: Active
description: Helping our new community members feel welcomed and lowering the barrier to entry for their first contribution.
slackName: onboarding
slackID: C03732G2R16
notesURL: https://docs.google.com/document/d/1uzYavYsCjJCQm_7ow5D5aPxu1u3bNIBK8BHxU2-9MEw
members:
- "[Ankita Tripathi](https://thegooddocs.slack.com/team/D016LHJPDSR)"
- "[Alyssa Rock](https://thegooddocs.slack.com/team/U012KCMPP0V)"
- "[Cameron Shorter](https://thegooddocs.slack.com/team/UKTGLQNGG)"
- "[Carrie Crowe](https://thegooddocs.slack.com/team/U01QS8YAHHN)"
- "[Chris Ganta](https://thegooddocs.slack.com/team/U023S2N2N3V)"
- "[Deanna](https://thegooddocs.slack.com/team/U01SXR5TKA6)"
- "[Meng](https://thegooddocs.slack.com/team/U02MXR41B5H)"
- "[Rob](https://thegooddocs.slack.com/team/U02FPRE1STA)"
- "[Ryan Macklin](https://thegooddocs.slack.com/team/U01DYRWG43X)"
draft: false
---
The goal of the onboarding group is to make everyone feel welcome in our community and that they have the support they need to contribute effectively in the Good Docs Project.
Our group will focus on:
- Going from zero to hero: how do new community members take the leap from first learning about our project to starting on their first contribution.
- Developing the supporting documentation and processes to help them on that journey.
- Building out training materials for onboarding with the project and its toolchain.
- Making sure everyone feels welcome, included, and valued for their own unique contributions.
---
title: Templates
leads:
- "Alyssa Rock"
- "Deanna Thompson"
- "Gayathri Krishnaswamy"
- "Joanne Fung"
- "Michael Park"
meeting: Check the [Community calendar](https://thegooddocsproject.dev/community/#calendar)
status: Active
description: Creates high-quality templates for common content types used in a variety of documentation projects.
slackName: templates
slackID: CPXECK804
notesURL: https://docs.google.com/document/d/1iRxB0T7FoVjIeG_LawbCzcLfXCILlpFdzn-4BPDGR9Y/edit?usp=sharing
draft: false
---
This group is great for both new and experienced technical writers.
We can always use more template writers.
If you’re not sure which working group to join, we generally recommend joining a template writing group.
The template project is our flagship project and the processes for contributing a template are well-established.
We have three template working groups you can join depending on which time zone works best for you:
- **Team Alpaca** - For the APAC and US regions
- **Team Macaw** - For the APAC and EMEA regions
- **Team Dolphin** - For the EMEA and US regions
\ No newline at end of file
......@@ -4,7 +4,7 @@
<div class="container">
<div class="row">
<div class="col-md-8">
<h1 class="mb-2">{{ .Title }} Working Group</h1>
<h1 class="mb-2">{{ .Title }} working group</h1>
<div class="mb-2">
<div class="text-muted pb-2">{{ partial "page-meta-lastmod.html" . }}</div>
</div>
......@@ -38,9 +38,14 @@
<strong>Status:</strong> {{ . | markdownify }}
<br>
{{ end }}
{{ with .Params.poc }}
<strong>Point of Contact:</strong> {{ . | markdownify }}
<br>
{{ with .Params.leads }}
</p>
<h3 class="my-3">Working group leads</h3>
<ul class="list-unstyled">
{{ range . }}
<li>{{ . | markdownify }}</li>
{{ end }}
</ul>
{{ end }}
{{ with .Params.meeting }}
<strong>Meetings:</strong> {{ . | markdownify }}
......@@ -50,15 +55,6 @@
{{ with .Description }}
{{ . }}
{{ end }}
{{ with .Params.members }}
</p>
<h3 class="my-3">Members</h3>
<ul class="list-unstyled">
{{ range . }}
<li>{{ . | markdownify }}</li>
{{ end }}
</ul>
{{ end }}
</div>
<div class="col-md-8">
<h3 class="mb-3">Information</h3>
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment