diff options
| author | Daniel James <daniel@calamity.org.uk> | 2009-06-01 19:18:00 +0000 |
|---|---|---|
| committer | Daniel James <daniel@calamity.org.uk> | 2009-06-01 19:18:00 +0000 |
| commit | 948feb0ddc0171b0c62222f2f3b38abb160c9c99 (patch) | |
| tree | c07b5fb7593ea3a778c03cab0511a0ea6cb5fe69 /more/writingdoc | |
| parent | f09981ba8a4dc0292b39ca2304dd1dbc80661a1d (diff) | |
| download | boost-948feb0ddc0171b0c62222f2f3b38abb160c9c99.tar.gz | |
Extra guidelines for writing documentation for the web.
[SVN r53551]
Diffstat (limited to 'more/writingdoc')
| -rw-r--r-- | more/writingdoc/structure.html | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/more/writingdoc/structure.html b/more/writingdoc/structure.html index 900f2a61a8..b63178530b 100644 --- a/more/writingdoc/structure.html +++ b/more/writingdoc/structure.html @@ -116,6 +116,14 @@ by the standard. Boost libraries should also provided additional documentation, such as introductory, tutorial, example, and rationale material.</p> + + <p>Since the documentation is also intended to act as a web reference, it's a + good idea to add some extra information to individual pages, especially + detailed reference pages. Full C++ identifiers and required headers are + especially useful and often overlooked. Remember that individual pages might + be accessed directly from a search engine or link, so readers won't have seen + information from previous pages. In reference pages, it can be helpful to link + to relevant tutorial information.</p> <h2><a name="standards-conforming" id="standards-conforming">Standards Conforming</a> Documentation</h2> |