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.

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

Recommend introduction (scope and goal) on each document #3

Open
benoitbryon opened this issue May 7, 2012 · 0 comments
Open

Recommend introduction (scope and goal) on each document #3

benoitbryon opened this issue May 7, 2012 · 0 comments
Assignees

Comments

@benoitbryon
Copy link
Owner

When a reader browse the documentation, he wants to quickly know what a document talks about. So that he can avoid reading something which he doesn't need to.
It's particularly important when looking for something: the topic of the document tells the reader whether he is looking at the right document or not.

So: write an introduction on each document.
Introduction should tell:

  • topic
  • scope
  • goal
@ghost ghost assigned benoitbryon May 31, 2012
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant