[Boost-bugs] [Boost C++ Libraries] #5391: Rework BBv2 documentation

Subject: [Boost-bugs] [Boost C++ Libraries] #5391: Rework BBv2 documentation
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2011-03-30 21:54:15

#5391: Rework BBv2 documentation
-------------------------------------+--------------------------------------
 Reporter:  grafik                   |       Owner:         
     Type:  Feature Requests         |      Status:  new    
Milestone:  To Be Determined         |   Component:  None   
  Version:  Boost Development Trunk  |    Severity:  Problem
 Keywords:                           |  
-------------------------------------+--------------------------------------
 There's lots of complaints about the BBv2 documentation Artyom had the
 good recommendation to structure it as:

 1. General Concepts:
  a. Syntax
  b. Rules
  c. etc.

 2. Tutorial How to do common stuff:
  a. Build a program
  b. Build a library
  c. Build a test
  d. Configure things conditionally
  e. Create extensions
  f. And so on.

    Pass on common features of Autotools, CMake, SCons
    and make sure users can easily figure out how to do.

 3. **Full** reference documentation:
  a. Properties
  b. Modules
  c. Rules

    And so on. This is even more important
    then tutorial because user and search
    for specific functions rules if they documented
    but he can't if there is no docs.

    As example I can provide ICU, their tutorials
    are very poor and basic but their reference docs
    are really great.

-- 
Ticket URL: <https://svn.boost.org/trac/boost/ticket/5391>
Boost C++ Libraries <http://www.boost.org/>
Boost provides free peer-reviewed portable C++ source libraries.