Content needed
We have drafted a style guide for use in Janeway end user documentation. It draws on the Google developer documentation style guide, and some of the recommendations in that guide are more about actual developer-facing documentation than end-user-facing docs.
So we need a developer to assess the parts of the Google guide that we want to adopt or adapt, and make updates to the Janeway style guide. This information should perhaps live not in memory-alpha but in the Janeway repository, given our choice to keep dev docs in openlibhums/janeway
We also need a developer to update the Contributing to Janeway documentation guide. Some of it can go away now that we have more comprehensive rules in the style guide, or be merged into the style guide. What's left will probably just be the nuts and bolts of using GH to write or edit docs, as well as pointers to the style guide. It should maybe be renamed Contributing to Janeway user documentation to make it clear it's about writing end-user docs and not developer docs.
Content needed
We have drafted a style guide for use in Janeway end user documentation. It draws on the Google developer documentation style guide, and some of the recommendations in that guide are more about actual developer-facing documentation than end-user-facing docs.
So we need a developer to assess the parts of the Google guide that we want to adopt or adapt, and make updates to the Janeway style guide. This information should perhaps live not in memory-alpha but in the Janeway repository, given our choice to keep dev docs in openlibhums/janeway
We also need a developer to update the Contributing to Janeway documentation guide. Some of it can go away now that we have more comprehensive rules in the style guide, or be merged into the style guide. What's left will probably just be the nuts and bolts of using GH to write or edit docs, as well as pointers to the style guide. It should maybe be renamed Contributing to Janeway user documentation to make it clear it's about writing end-user docs and not developer docs.