-''NOTE: some of the formatting of this page is a little messed up because it was not written for wiki, to see it clean, click edit and copy the raw text and paste it into a text editor. -Will''
|
+{maketoc} |
|
+!!Documenting BW and bw.o Site Restructuring Proposal |
|
-********************************************************
|
-!Documenting BW and bw.o Site Restructuring Proposal
|
-********************************************************
|
-CONCEPT: I propose to undertake some leadership of enhancing the marketing of BW and expanding the developer base. This would be achieved through two non-trivial programs:
|
+^CONCEPT: I propose to undertake some leadership of enhancing the marketing of BW and expanding the developer base. This would be achieved through two non-trivial programs: |
|
-1. Restructure bw.o
|
-2. Enhancing the documentation of BW to a highly reliable level, such that developers new to BW can easily build out a complex package utilizing all the core services of Liberty and the Kernel.
|
+#Restructure the bw.o site |
+#Creating documentation for BW, such that developers, admins and end users can fully utilize all the core services of Liberty and the Kernel. |
|
I see the restructuring of bw.o as part of and necessary to enhancing the documentation of BW, as it is my observation that while there is much good documentation on the site, it is not easy to find, and the relationships between documents are not easy to grasp.
|
|
Specifics of my bw.o site restructuring proposal follow this introduction.
|
|
-The Documenting of BW shall be taken up as a high profile project on bw.o and evangelized to the BW small but dedicated developer community. This means raising documenting BW to the level of a call to action. This project will have a clear road map, goals will be set, needs will be clearly defined and prioritized, update reports given, all done with the intent to encourage other developers in the BW ring to help out. As the ultimate goal of this project is to relieve pressure on the core BW developers, I am seeking your participation as evangelists of this project.
|
+(Will)^ |
+ |
+ |
+!!Documentation |
+ |
+__Using the "wiki method":__ The most important step to achieving good documentation by wiki not answering documentation type questions email or IRC. This "tough love" practice serves the developers well because they will only have to answer questions once, and as a courtesy in return for having questions answered the questioners should ((refactor)) the developer's (likely hurried) answers using the ((style guide)). This approach leaves proper documentation for the next person that comes along with the same question. |
+ |
+Ultimately this kind of "user training" will relieve pressure on the core BW developers to do all the work. |
+ |
+Having a coherrent decision making method for editorial purposes, and a well planned structure to the document, complete with a ((style guide)). |
|
The documentation road map will be a prioritized list of items to complete. Here is a preliminary proposed high level list of prioritized goals:
|
|