Issue 75 in gvn: docbug: leftover google doc style hints in design.html
codesite...@google.com
Owner: ----
New issue 75 by junk: docbug: leftover google doc style hints in design.html
http://code.google.com/p/gvn/issues/detail?id=75
Looks like some of the Google internal documentation style hints were left
over in design.html:
"""
Background
Stuff one needs to know to understand this doc: motivating examples,
previous versions and problems, links to related projects/design docs, etc.
You should mention related work outside of Google if applicable. Note: this
is background; do not write about your design or ideas to solve problems
here.
"""
and
"""
Overview
One page high-level overview; put details in the next section and
background in the previous section. Should be understandable by a new
Google engineer not working on the project.
"""
What steps will reproduce the problem?
1. Read design.html
What is the expected output? What do you see instead?
This information is part of the internal Google documentation style guide
and should be removed from published docs.
What version of the product are you using? On what operating system?
Linux, Rev 987.