wiki:ImprovingBoostDocs

Version 147 (modified by Matias Capeletto, 15 years ago) ( diff )

--

Improving Boost Docs Project

Table of contents

  1. Objectives
  2. News
  3. Statistics
  4. Downloads
  5. How to help
  6. Project Wiki
  7. People
  8. Team Mascot
  9. Acknowledgments

Objectives

Design

  • Build up a long term community of people that cares and constantly improve boost documentation and tools.
  • Achieve an unified look and feel between docs and Boost resources, integrating them as much as possible.
  • Quality documentation

    • Provide correct, current and readable documentation for the Boost C++ libraries, tools, environment and organization.

    • Generate Glue docs that sees boost as one tied entity, providing real-world examples, best practices for common tasks and tutorials about how to combine Boost libraries together to build high-quality C++ applications.

    • Provide a publicly available, vendor-neutral reference manual for the Standard C++ library, STL concepts, data types and algorithms as part of the Boost library documentation.

    • Make it easier for users to navigate through the enormous amount of boost documentation.

    • Use latest version of standards and support old browsers.

    • Include nice looking logos and diagrams. Although Boost libraries are so great that they do not need any marketting at all, lets face it: people are attracted like flies to catchy names and fancy pictures.
  • Documentation tools and support

    • Improve the docs tool chain, simplifying and integrating it lowering the barrier for people willing to help us.

    • Develop tools to automate common task, and to make life easier to boost authors. Docs writers should concentrate on generating content and not on figthing with tools.

    • Work to make doc tools boost-agnostic. We believe that they are useful beyond the boost community, and would welcome anyone who wishes to use, extend or support them.
  • Generate formal documents about C++ documentation best practices.
  • Offer our help to libraries authors. This include translations, proof-reading, proposing examples and tutorials for their libraries and helping them with the docs tool chain.
  • Offer a place where not C++ experts can help the Boost community. In general the tasks we do here does not involve template metaprogramming or others complex C++ machinery. Dessigners, artists, teachers, web experts, Python programmers and Boost users are very welcome along our lines.
  • Write docs, include rationales, use our own tools. If we want to improve boost docs, we should start by showcasing best practices in this project.
  • Enjoy our work. If we are not having fun while improving boost docs something has gone terribly wrong.

News

News

​Go to google calendar

  • 2007-07-03 : A new community builder tool for the project: ​Linked In. Be part of our network of trust.
  • 2007-07-03 : Change date format to be ​ISO 8601 compliant.
  • 2007-07-03 : Ohloh statistics for ​our project.
  • 2007-07-02 : New project: Boost Debugger Visualizers. Welcome Filip!
  • 2007-07-02 : Formal presentation of the project. 32 downloads on the first 12 hours!
  • 2007-07-01 : Initial structure of the Boost Glue docs project.
  • 2007-07-01 : First Release of Boost Docs!
  • 2007-06-30 : We will use ​ohloh as a community builder tool and for statistics about our project.
  • 2007-06-30 : Two new objectives: Standard C++ Library Boosted Docs and Documentation Best Practices.
  • 2007-06-29 : Stuart Dootson will be our browser testing manager. Thanks!
  • 2007-06-29 : Add fancy graphics to the wiki.
  • 2007-06-28 : The formal objectives of the project have been outlined.
  • 2007-06-28 : We are trying to build a long term community of people that cares and constantly improve Boost docs. With that in mind new sections have been created: Subprojects, People, and Acknowledgments; including pictures of us to make us feel as a group.
  • 2007-06-28 : The community is growing: Peter Foley starts the SVG icons set project. Welcome Peter!
  • 2007-06-27 : Help needed for a new project: Boost specific WikiMacros ( ​more information )
  • 2007-06-27 : "Quickbook as a WikiProcessor for our Trac", let us know we can count on you! ( ​more information )
  • 2007-06-26 : New project waiting for a developer: "Trac Syntax Coloring for Boostbook, Quickbook and Jamfiles". ( ​more information )
  • 2007-06-26 : Initial Boost Docs organization proposal.
  • 2007-06-25 : We have now a repository to organize our work. More information in the boost docs repository page.
  • 2007-06-25 : The wiki is now easy to navigate!
  • 2007-06-24 : Glyn Matthews volunteers to do the HTML to Docbook project. Thanks!
  • 2007-06-22 : New page! Go and see the logo playgroung page.
  • 2007-06-22 : The new docs are being tested by volunteers in different platforms and browsers. Go to the browser testing chart.
  • 2007-06-22 : Some subprojects have been outlined so people willing to collaborate can jump in and became a part of the project.
  • 2007-06-22 : A new translation tool has been released! ( ​more information )
  • 2007-06-21 : Syntax highlighting, Revolution! ( ​more information )
  • 2007-06-19 : Four really cool guys volunteers to translate docs to quickbook ( ​more information )
  • 2007-06-18 : A few steps from XHTML 1.1 validation ( ​more information )
  • 2007-06-15 : Box wrappers support in Boostbook ( ​more information )
  • 2007-06-12 : New Grouped Links select boxes in header ( ​more information )
  • 2007-06-11 : Linked CSE Google search box in header ( ​more information )
  • 2007-06-09 : Test document for new styles ( ​more information )
  • 2007-05-24 : Translation of Boost.NumericConversion from HTML to Quickbook completed.
  • 2007-05-23 : Translation of Boost.Optional from HTML to Quickbook completed.
  • 2007-05-16 : Translation of Boost.Config from HTML to Quickbook completed.

Statistics

http://gmane.org/plot-rate.php

​Ohloh Based Project Statistics

Downloads


Boost Docs 2007-07-01

​Boost Docs 2007-07-01 at Boost Vault
svn export http://svn.boost.org/svn/boost/sandbox/boost_docs/tags/boost_docs_2007-07-01

Release notes

  • Initial version of Boost.DocTest
  • Initial version of Boost Style
    • Modular CSS design.
    • CSS based admonitions and navigation graphics.
    • Quickbook source stylesheet.
  • Boostbook improvements
    • Almost Valid XHTML 1.1 output.
    • New header and footer based on beta.boost.org.
    • GroupedLinks select boxes for Boost Libraries and Section quick jumping.
    • Google Search box over our docs.
    • Box-wrapper based blurbs that allow us to include rounded corners, drop shadows, etc.
    • Alternatives syntax highlighting including most common IDEs.
    • Chapter logo support.
    • Parameters clean up.
    • A new PDF stylesheet based on the unified look and feel project.
  • Quickbook improvements
    • Initial support for SVG images in HTML docs.

Installation Notes

Copy the contents of the Boost Docs zipped file into an up to date Boost package.

How to help

Help wanted

There are small projects waiting for one or two folks to jump into them.

Other ways to help us

  • Jump in as a browser tester ( More information in the browser testing chart page )
  • Docs Translator ( More information in the docs translations project page )
  • Comment about our work. We need constant feedback, please scream your opinion in the ​boost-docs list.
  • Lot of documentation on this Wiki is being written by non-native English speaker. Just reading and correcting expressions and paragraph will be appreciated.

If you are...

  • ... a web designer, you can help us with our HTML docs projects.
  • ... an artist, you can propose graphics to make boost look fancier.
  • ... a teacher, you can write tutorials for the Glue Docs project.
  • ... a Boost user, you can provide us with real life examples for the Glue Docs project.
  • ... a Python programmer, you can help us integrating stuff into Trac.

Project Wiki

Improving Boost Docs Wiki

  • Boost Docs repository
    We are working on several boost tools to support the new features and improve their usability. This work is stored in boost sandbox. Go to the boost docs repository page to learn how it is organized.
  • Unified look & feel project
    Although Boost libraries are independent entities, together they build a superb and tied library. If we want People to understand this we must provide an unified style for our docs and resources. This project will define the guidelines for the new look and feel of Boost.
  • Docs Translations
    If we want to have an unified look and feel in boost docs, we need that all documentation be in a standard format. We are translating HTML based docs to Docbook format. There are a lot of documents to translate, we need more volunteers to help in the process. If you want to participate go to the docs translations project page. (We now have a bunch of tools that makes painless the process, please jump in!)
  • Glue Docs
    Boost libraries documentation are an impressive tool to learn about how individual libraries work. However we are missing integration documentation, that sees boost as a whole. How do we do common task, which libraries are powerful when combined, real life examples; are important documentation we can not expect boost authors to provide. The Glue Docs project objective is to build the necessary meta-library documentation for Boost.
  • Standard C++ Library Docs
    Provide a publicly available, vendor-neutral reference manual for the Standard C++ library, STL concepts, data types and algorithms as part of the Boost library documentation.
  • Documentation Best Practices
    Formal documents about C++ documentation best practices.
  • Documentation Tools
    Projects to improve the docs tool chain, simplifying and integrating it lowering the barrier for people willing to help us.
  • Subprojects
    There are some small subprojects targeted to solve specific needs. Go to the subprojects page to participate in them.
  • Browser testing
    Volunteers are periodically testing the new docs in each platform and browser.
  • Libraries Logos
    Go to the logo playground page to find proposed logos for Boost libraries.

People

The people list here is working on this project of has done work on the tools in wich this work builds up. Some of them may not endorse all the proposal of the project, but all have gave their blessing to it. If you are working for this project and do not appear here, please add yourself to the list. If you are listed and want to share your mail and picture here, please add them.



Andrew Sutton
​Ohloh Statistics
asutton at cs dot kent dot edu

Cédric Venet
Cédric Venet
​Linked In Profile
cedric dot venet at student dot ecp dot fr


Darren Garvey
​Ohloh Statistics
unknown mail

Douglas Gregor
Douglas Gregor
​Ohloh Statistics
unknown mail

Eric Niebler
Eric Niebler
​Ohloh Statistics
​Linked In Profile
unknown mail


Filip Konvička
unknown mail

Glyn Matthews
Glyn Matthews
​Linked In Profile
glyn dot matthews at gmail dot com

Jake Voytko
Jacob Robert Voytko
​Ohloh Statistics
jakevoytko at gmail dot com

Joel de Guzman
Joel de Guzman
​Ohloh Statistics
​Linked In Profile
unknown mail

John Maddock
John Maddock
​Ohloh Statistics
unknown mail

Matias Capeletto
Matias Capeletto
​Ohloh Statistics
​Linked In Profile
matias dot capeletto at gmail dot com


Paul Bristow
unknown mail


Peter Foley
boost at ifoley dot id dot au

Rene Rivera
Rene Rivera
​Ohloh Statistics
​Linked In Profile
unknown mail

Stjepan Rajko
Stjepan Rajko
​Ohloh Statistics
stjepan dot rajko at gmail dot com

Stuart Dootson
Stuart Dootson
stuart dot dootson at gmail dot com

Team Mascot


Mafalda - Team Mascot
Mafalda
Team Mascot

She is a ​English Springer Spaniel from Argentina, currently living with Matias. Mafalda is helping him with the project Wiki page. She just barks once in a while, but that is a lot.

Acknowledgments

http://matias.capeletto.googlepages.com/thanks.png

Big thanks to Daniel James, Janek Kozicki, João Abecasis, Matt Doyle, Michael Marcin. You are welcome to became active members of the project, in that case please add yourself to the list above. Thanks to all the others that have help us with discussion on the boost list.

Attachments (5)

Download all attachments as: .zip

Note: See TracWiki for help on using the wiki.