From 948feb0ddc0171b0c62222f2f3b38abb160c9c99 Mon Sep 17 00:00:00 2001 From: Daniel James Date: Mon, 1 Jun 2009 19:18:00 +0000 Subject: [PATCH] Extra guidelines for writing documentation for the web. [SVN r53551] --- more/writingdoc/structure.html | 8 ++++++++ 1 file changed, 8 insertions(+) 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.

+ +

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.

Standards Conforming Documentation