boost/more
1
0
Fork 0
mirror of https://github.com/boostorg/more.git synced 2025-03-15 11:50:11 +08:00
Code Issues Packages Projects Releases Wiki Activity

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 5c09905f94
commit fbb60689b7
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
writingdoc/structure.html
View File

@ -116,6 +116,14 @@
by the standard. Boost libraries should also provided additional by the standard. Boost libraries should also provided additional
documentation, such as introductory, tutorial, example, and rationale documentation, such as introductory, tutorial, example, and rationale
material.</p> 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 <h2><a name="standards-conforming" id="standards-conforming">Standards
Conforming</a> Documentation</h2> Conforming</a> Documentation</h2>