-
-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Create a document template for Guides #123
Comments
@Olivia-Chiong is the end user for this the Product Management team (to document internal policies) or is this for other teams/uses as well? I'm expecting the use case is internal documentation, and is not intended to be used for new feature documentation. |
@mariastudnicka created a very nice design for this guide and I am told we can make it into a template. |
@rmcrowell This is for PM team and we are also sharing it on the website for external. I think you've made a lot of good progress. Do you think it's ready for review? |
@rmcrowell sorry for the delay in getting back to you Formatting Issues:
Examples:
Who its for:
|
This document is updated and ready for review. Document can be found at https://docs.google.com/document/d/1-8gmeC-wnfM8C8fVvmTP1BLA2WfNjKH_XJrHB1OAV6Q/edit?usp=sharing |
@ktjnyc is going to take a look to see if the template encompases everything she would have needed if there was a template before she started. @Olivia-Chiong we should assign anyone who is done with a guide draft now, to review this template and see if same as above. |
@rmcrowell the guide is missing a WHEN section. See the slack guide for an example |
@erigilg Since you made the tracker for the guides, can you review this template Rose has come up with and provide any suggestions/comments? Thanks! |
I left a few comments in the document as well, but some general feedback:
|
Added my comments to the doc but in general:
|
@tan-zhou and @daniellex0 this is the guide/template for creating guides. It's a WIP, but would love to have your input. Thanks! |
Overview
We need to create a document template for guides so all guides are standardized.
Action Items
Resources/Instructions
Google drive for new document
Guide draft
Template for Creating a Guide (referenced in the guide to making a guide)
The text was updated successfully, but these errors were encountered: