Skip to content
This repository was archived by the owner on Jun 2, 2020. It is now read-only.

Create first-round documentation guidelines/pointers #350

Closed
jessicaschilling opened this issue Oct 9, 2019 · 2 comments
Closed

Create first-round documentation guidelines/pointers #350

jessicaschilling opened this issue Oct 9, 2019 · 2 comments
Assignees
Labels
dif/easy Someone with a little familiarity can pick up effort/hours Estimated to take one or several hours topic/design-content Content design, writing, information architecture topic/docs Documentation

Comments

@jessicaschilling
Copy link
Contributor

We're doing awesome work in Q4 to ramp up the docs effort overall, but one item in the near term that can provide a lot of value right away is to create a simple, concise guide to help developers create first-round documentation for net-new work, or document incremental improvements on existing work.

This can be presented alongside the IPFS contributor guidelines, as well as potentially a handful of other useful places; let's use this issue to brainstorm about where those would live, too.

@jessicaschilling jessicaschilling added dif/easy Someone with a little familiarity can pick up topic/design-content Content design, writing, information architecture docs-ipfs effort/hours Estimated to take one or several hours topic/docs Documentation labels Oct 9, 2019
@ericronne
Copy link
Contributor

ericronne commented Oct 9, 2019

Yes! I think this is could help us approach what I pictured back at IPFS team week (referenced in this issue):

Create support tools to help everyone "be the docs person you want to see in IPFS"

A documentation template with simple guidelines might be a great start.

@jessicaschilling
Copy link
Contributor Author

Closing this issue, as it's been superseded by the larger "docs personality" effort in #392.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
dif/easy Someone with a little familiarity can pick up effort/hours Estimated to take one or several hours topic/design-content Content design, writing, information architecture topic/docs Documentation
Projects
None yet
Development

No branches or pull requests

3 participants