[Boost-commit] svn:boost r53551 - trunk/more/writingdoc

Subject: [Boost-commit] svn:boost r53551 - trunk/more/writingdoc
From: daniel_james_at_[hidden]
Date: 2009-06-01 15:18:01

Author: danieljames
Date: 2009-06-01 15:18:00 EDT (Mon, 01 Jun 2009)
New Revision: 53551
URL: http://svn.boost.org/trac/boost/changeset/53551

Log:
Extra guidelines for writing documentation for the web.
Text files modified: 
   trunk/more/writingdoc/structure.html |     8 ++++++++                                
   1 files changed, 8 insertions(+), 0 deletions(-)

Modified: trunk/more/writingdoc/structure.html
==============================================================================
--- trunk/more/writingdoc/structure.html	(original)
+++ trunk/more/writingdoc/structure.html	2009-06-01 15:18:00 EDT (Mon, 01 Jun 2009)
@@ -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>