BSDDF:Main
From NetBSD Wiki
Welcome to the BSD Documentation Framework Wiki!
This project is the effort to create generic documentation framework for all BSD projects, including BSD Certification Group, DesktopBSD, DragonFly BSD, FreeBSD, NetBSD, OpenBSD, and PCBSD.
Contents |
What we are talking about
xBSD projects are focused on producing high quality, powerful, multipurpose operating systems, and information sharing is a important part of the production process. People obtain information by many different ways, including browsing web-sites, reading books, referencing to man-pages and more (see BSDDF:Information Access Methods).
But before anybody will able somehow access any data, it must be prepared first. All the preparation procedures together are called workflow, and environment where these procedures occurs is called framework. Unfortunately, any of xBSD does not have well defined workflow, and all projects are using random tools to handle their own (usually self-made) framework. This brings a set of problems which are detaily explained at BSDDF:Framework Problems page.
The proposed way
The solution is obvious -- create well determined and complete workflow, supported with lightweight, easy to use, and flexible tools, which would allow to handle day-to-day documentation tasks. It can be already existent framework, or one developed from the start. But in any case this work must be targeted by well defined goals. Thus, some initial discussion on the following things is needed:
- Define the need
- Establish the mission
- Proclaim the goals
These and further steps described at BSDDF:Work Plan.
Join the team
If you have experience in documentation processing, or if you know details on any of existing documentation frameworks or technologies they are build on, please consider to join us:
- Wiki/WWW: http://wiki.NetBSD.se/index.php/BSDDF:Main (this site)
- IRC: #bsddf channel on Freenode (irc://irc.freenode.net/#bsddf)
At this moment we need some other collaboration and communication tools. Please let me know if you can support us with the following:
- Maillist
- Source Repository
Thanks in advance.
About this Wiki
This Wiki pages are aimed to be the single source for all information related to BSD Documentation Framework. Currently they're hosted by http://wiki.NetBSD.se/ site. Please use BSDDF namespace for any new page related to BSD Documentation Framework, for example: BSDDF:Main. Also, don't forget to add your new pages to BSDDF category by placing [[Category:BSDDF]] at the top of every page.
Random Stuff
Information under this section must be moved to other pages or relayouted here.
Who is Involved
The following people usually managed to utilize the information:
- users
- developers
- system managers
- business managers
- resellers
Work Plan
Existent 3rd Party Frameworks and Tools
Current xBSD Frameworks
Bad Framework Problems
- compatibility ...
- maintenance ...
- representation ...
- learning curve...
- technical design...
