organicmaps/boost
13
Fork 0
mirror of https://github.com/boostorg/boost.git synced 2025-04-07 22:39:25 +00:00
Code Issues 1 Projects Releases Wiki Activity Actions

Extra guidelines for writing documentation for the web.

Browse source 
[SVN r53551]
This commit is contained in:
Daniel James 2009-06-01 19:18:00 +00:00
parent f09981ba8a
commit 948feb0ddc
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
more/writingdoc/structure.html
View file

@ -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>