[openstack-dev] [docs] Updating the docs team mission statement
doug at doughellmann.com
Tue Aug 22 12:30:28 UTC 2017
Excerpts from Doug Hellmann's message of 2017-08-08 08:11:25 -0400:
> Excerpts from Thierry Carrez's message of 2017-08-08 12:28:58 +0200:
> > Petr Kovar wrote:
> > > Hi all,
> > >
> > > With the core docs suite moving from openstack-manuals to individual
> > > project repos as per
> > > http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html,
> > > it's also time to update the docs team mission statement from
> > > https://governance.openstack.org/tc/reference/projects/documentation.html.
> > >
> > > What are everybody's thoughts on what should the new mission statement
> > > say now that most OpenStack docs maintenance is in the hands of project
> > > teams?
> > >
> > > One idea is for the docs team to act as a focused group of editors and
> > > maintain a common set of guidelines, recommended practices (style
> > > guidelines come to mind, for instance), and requirements (such as a common
> > > docs and publishing structure shared across projects).
> > I would say something like:
> > The docs team provides guidance, assistance, tooling, and style guides
> > enabling OpenStack project teams to produce consistent, accurate, and
> > high-quality documentation.
> Thanks for starting this thread, Petr.
> To make it easier to compare, here's the current mission statement:
> Provide documentation for core OpenStack projects to promote
> OpenStack. Develop and maintain tools and processes to ensure
> quality, accurate documentation. Treat documentation like OpenStack
> Thierry's suggestion highlights some of the changes I see coming
> for the docs team. I would like to hear from some of the other team
> members about what they think about that.
This thread died out, but I think it's important that we make some
progress on the discussion before the PTG because the outcome is
going to influence the work we do there.
One way we could approach it is to make a list of all of the things
that the team is currently doing (or has been doing, up to Pike)
and then review that list to consider which of those things, if the
team was not already doing them, you would be willing to start doing
today. That should establish a pattern for the types of tasks and
initiatives the team thinks it can manage, and help us focus the
So, what does the docs team "do" or "make" today?
More information about the OpenStack-dev