У Boost нет никаких требований к тому, как вы пишете документацию. Если вы отправляете библиотеку, которая уже имеет письменную документацию в формате HTML, нет никаких оснований изменять ее, чтобы следовать любым из представленных здесь рекомендаций. Однако, если у вас есть документация, которая не в формате HTML и не может быть легко преобразована в HTML, или если вы начинаете с нуля или у вас есть библиотека без документации, то эти рекомендации могут сделать написание документации намного проще.
В разделе Структура документации описывается, как структурировать содержание документации. Этот раздел может быть полезен даже для библиотек, которые уже имеют документацию. Если есть желание представить библиотеку для возможного включения на C++ Стандарты В этом случае Комитету может потребоваться реструктурировать содержание документации, с тем чтобы обеспечить соответствие содержания явным требованиям к компонентам библиотеки (раздел 17.3).
В разделе HTML Design приведены общие правила, которым следует следовать при написании HTML-документации. Этот раздел также содержит некоторые файлы шаблонов, которые можно использовать для быстрого создания страниц документации.
Пересмотрено 04 Декабря 200604
December, 2006[ORIG_END] -->
