Documentation [FreeBSD WIKI]

This is an old revision of the document!

Note: Do not edit this page yourself unless asked to.

(Add the exact date and time of your working group here.)

This working group mainly focuses on trying to pick up what was left from the session at BSDCan's DevSummit and the combined BSDCan/PGCon doc summit and continue what actions and solutions have been identified there as well as new things that came up in the meantime.

If you would like to participate, contact the working group chairs below and CC devsummit@. You will be then added to this page. Please include a list of things you want to talk about or the areas you are interested in. This helps us in planning the session and to bring people together with common interests.

It is possible to bring in people who cannot attend in person via video conference or chat tools. Notes during the session will be published later on for the whole community to see what we discussed.

In particular, we would like to cover the following topics. This is not an exhaustive list and if you feel there is something missing that you want to talk about, contact one of the session chairs and we will include your topic here. Note that the numbering of the topics does not represent an ordering or importance indication of any kind, but rather a reference to the second table with the “topic of interest” column.

#	Topic Description
XML DocBook conversion	It is either already there by the time EuroBSDcon happens or the conversion is still ongoing. Either way, it should be discussed what is left to do, like updates to the FDP primer and training of our doc committers to the new doc infrastructure based on XML.
Handbook print and electronic editions	Now that there is SVN with support for branches, the reorganization of the handbook into a publishable format (including but not limited to: the preface with all the changes since the last publicized version) could be started. Discuss what is the best format to do this and how to divide the work among those who are interested in seeing this happen.
Doc tools	Tools for documentation work, little helper scripts (like one for comparing revisions between translation projects and the en_US repo tree) should be talked about. Collecting more ideas for tools that we could create/use and distribute the work to make them available is one goal.

Note: General presentations about work you have done that does not require further discussions should be submitted for the FreeBSD Developer Summit track at EuroBSDcon (see general developer summit page).

In order to attend you need register for the developer summit as well as by email for the session and be confirmed by the working group organizer. Follow the guidelines described on the main page or what you received by email. For questions or if in doubt ask the session chairs.

Everyone interested in documentation is welcome to join. This includes doc committers and contributors, but we have also learned in the last sessions that sometimes ports, src and even infrastructure people can provide valuable insights into problems the doc people scratch their heads about far longer than necessary. So a mixed audience is welcome, but we will also try to keep the number of attendees small enough to be productive.

Please do NOT add yourself here. Your name will appear automatically once you received the confirmation email. You need to put your name on the general developer summit attendees list though.