Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Explain goal/use-case first for documentation #35

Closed
jennifer-shehane opened this issue Sep 6, 2017 · 0 comments
Closed

Explain goal/use-case first for documentation #35

jennifer-shehane opened this issue Sep 6, 2017 · 0 comments
Labels
content: rewrite

Comments

@jennifer-shehane
Copy link
Member

@jennifer-shehane commented on Tue Jun 20 2017

Inspired by this Twitter thread.

Key Takeaway: Explain first what the goal, or use-case, or desired result is.

Suggested Structure?

# [title]

## Whats the point?
We want to [x] with code that looks like [code]

## How to get there
[docs]

@brian-mann commented on Tue Jun 20 2017

Love it. I'm not saying to do this now, but can/could you audit the first several important guides / docs which need this implemented / improved?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
content: rewrite
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@amirrustam @jennifer-shehane