Last modified 10 years ago Last modified on 07/23/07 21:03:34

Improving Boost Docs Project


Standard C++ Boosted Documentation

Table of contents

  1. Introduction
  2. Concept Documents
  3. Reference Documents
  4. Active developers


Introduction

The goal of this documentary subproject is to produce concept and reference documentation for the Standard Template Library. Although much of this is very nicely documented and made available by SGI, there are several reasons that Boost should provide a set of documents under its own umbrella. As a stated goal in the Boost charter, "We aim to establish 'existing practice'" and many libraries documents espouse "Best Practices". This project falls under these auspices. This project aims to establish existing practice for providing concept and reference documetnation for C++ libraries.

Additional benefits in developing these documents include, a) a unified look and feel for STL+Boost documents and b) closer control over their content and presentation of the information. Essentially, this gives us a chance to work out more effective ways of presenting concept and reference material - which could be interesting with concepts becoming a major part of the new C++0x standard.

Most documentation for generic libraries can be cleanly divided into two different parts: concept documents and reference documents.


Concept Documents

Concepts documents describe the requirements on types (both built-in and user-defined) in order for them to be used with classes and functions provided by the library.


Reference Documents

Reference documents defines the actual types and functions used by developers. Despite common practice reference documentation should be more than simply listing namespaces, classes, and functions. Good reference documents should provide examples and advice for "Best Practices".


Active developers



Andrew Sutton
Ohloh Statistics
asutton at cs dot kent dot edu



Attachments