mirror of
https://github.com/boostorg/more.git
synced 2025-03-13 11:40:11 +08:00
Extra guidelines for writing documentation for the web.
[SVN r53551]
This commit is contained in:
parent
5c09905f94
commit
fbb60689b7
@ -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>
|
||||
|
Loading…
Reference in New Issue
Block a user