Hello everyone,
Summary
WMF’s technical writers are currently working on a dashboard that will
display documentation metrics to help us make more data-driven docs
decisions. We are currently in the design stage. If you maintain
technical documentation for your team or project, we are very
interested in hearing your thoughts! Please take a look at the
requirements [1] and initial design ideas [2] and share your feedback
either on talk pages or in Phabricator [3].
Long version
Technical writers at WMF have started a project to gather relevant
documentation metrics in one place. The intended outcome of this
project is a publicly-available dashboard. This dashboard will help
anyone who is maintaining documentation collections (sets of pages
that describe the same project, tool, or area) to reason about the
state of their docs, and plan documentation work.
The dashboard will be immediately useful to technical writers, but we
also want to design it in a way that will serve the broader community,
specifically including the perspective of folks who only work with
documentation occasionally. To this end, we’ve decided to reach out to
you early to gather feedback about the requirements [1] and our
initial design assumptions [2]. If you actively maintain any technical
documentation, please take a look at the linked resources and share
your thoughts and comments on talk pages or in Phabricator [3]. Thank
you!
On behalf of WMF’s technical writers,
Kamil Bach
[1] https://www.mediawiki.org/wiki/Documentation/Tools/Documentation_metrics_dashboard
[2] https://www.mediawiki.org/wiki/Documentation/Tools/Documentation_metrics_dashboard/Design
[3] https://phabricator.wikimedia.org/T334839
--
Kamil Bach (they/them)
Technical Writer
Wikimedia Foundation
_______________________________________________
Wikitech-l mailing list -- wikitech-l@lists.wikimedia.org
To unsubscribe send an email to wikitech-l-leave@lists.wikimedia.org
https://lists.wikimedia.org/postorius/lists/wikitech-l.lists.wikimedia.org/
Summary
WMF’s technical writers are currently working on a dashboard that will
display documentation metrics to help us make more data-driven docs
decisions. We are currently in the design stage. If you maintain
technical documentation for your team or project, we are very
interested in hearing your thoughts! Please take a look at the
requirements [1] and initial design ideas [2] and share your feedback
either on talk pages or in Phabricator [3].
Long version
Technical writers at WMF have started a project to gather relevant
documentation metrics in one place. The intended outcome of this
project is a publicly-available dashboard. This dashboard will help
anyone who is maintaining documentation collections (sets of pages
that describe the same project, tool, or area) to reason about the
state of their docs, and plan documentation work.
The dashboard will be immediately useful to technical writers, but we
also want to design it in a way that will serve the broader community,
specifically including the perspective of folks who only work with
documentation occasionally. To this end, we’ve decided to reach out to
you early to gather feedback about the requirements [1] and our
initial design assumptions [2]. If you actively maintain any technical
documentation, please take a look at the linked resources and share
your thoughts and comments on talk pages or in Phabricator [3]. Thank
you!
On behalf of WMF’s technical writers,
Kamil Bach
[1] https://www.mediawiki.org/wiki/Documentation/Tools/Documentation_metrics_dashboard
[2] https://www.mediawiki.org/wiki/Documentation/Tools/Documentation_metrics_dashboard/Design
[3] https://phabricator.wikimedia.org/T334839
--
Kamil Bach (they/them)
Technical Writer
Wikimedia Foundation
_______________________________________________
Wikitech-l mailing list -- wikitech-l@lists.wikimedia.org
To unsubscribe send an email to wikitech-l-leave@lists.wikimedia.org
https://lists.wikimedia.org/postorius/lists/wikitech-l.lists.wikimedia.org/