Documentation Values

[chrisdickinson]

One of the action items from Nodeconf was to put together a set of values for both our docs and our team so that we've got a good basis for making decisions about the docs. I'm going to take a stab at writing this over the next day or two.

My goal will be to cover strategic values, tactical values, and mechanical values – so that any doc team member can easily use these values when determining what to start writing, how to write it, how to edit it, and what to look for when editing other's work. I will submit the style guide piecemeal to this repo as a series of PRs so that we can discuss these values.

A brief definition of terms: strategic values will influence our long-term goals for these docs. They should help us decide how to move the project forward and set priorities.. Tactical values influence the actual writing of the docs – what to write and how to approach writing it. Mechanical values are the most like a traditional style guide – how to format the documentation source, grammar rules, etc.

If folks have input ahead of the PRs, please comment here! I'll be associating all of the PRs with this issue so you'll see 'em as they pop up.

[mikeal]

this was brought up in the context of a lot of the diversity work so we should probably ping the @nodejs/diversity team :)

[Fishrock123]

Yes, we may have some things to say about the strategic values.

[chrisdickinson]

To set expectations, these aren't intended to be larger-level project-wide values documents, but:

• Ultimately these documentation values documents should reflect those project-wide values,
• The project-wide values should be captured in documentation here.

You can see the work in progress version in PR #5.

[Fishrock123]

• Ultimately these documentation values documents should reflect those project-wide values,
• The project-wide values should be captured in documentation here.

That is what I mean. :)

[chrisdickinson]

These are largely captured in the GETTING-STARTED.md guide and the ROADMAP process — closing this out now.