Welcome

Message boards : Documentation : Welcome
Message board moderation

To post messages, you must log in.

AuthorMessage
Eric Myers
Avatar

Send message
Joined: 12 Feb 06
Posts: 232
United States
Message 10689 - Posted: 5 Jun 2007, 15:37:38 UTC
Last modified: 5 Jun 2007, 15:41:00 UTC

As you can see, we now have a separate forum for discussions about documentation. I think it's useful to think of the documentation as another main componenent of the whole BOINC system.

We can use this to plan and debate both the official documentation and any unofficial add-ons (eg. the wiki, the FAQ, the team sites).

So where do we start?

-- Eric Myers

"Education is not the filling of a pail, but the lighting of a fire." -- William Butler Yeats
ID: 10689 · Report as offensive
Lee Carre

Send message
Joined: 8 Sep 05
Posts: 74
Channel Islands
Message 10802 - Posted: 9 Jun 2007, 8:25:51 UTC - in response to Message 10689.  
Last modified: 9 Jun 2007, 8:26:56 UTC

I think it's useful to think of the documentation as another main componenent of the whole BOINC system.
I agree, there any many sub-features of BOINC as a whole which are under-represented; such as the critically important web development side of things, especially front-end code development.

We can use this to plan and debate both the official documentation and any unofficial add-ons (eg. the wiki, the FAQ, the team sites).

So where do we start?

As with any good planning;

    *Begin with who the target audience(es) is/are, and their needs.
    *Clearly defined/specified purpose of the site/project.
    *Goals that the site/project is going to achieve.
    *A general/basic idea of how those goals are going to be achieved - this is in the relm of big-picture features, such as using a wiki (but not calling it a wiki on the site; "Knowledge Base" is more appropriate)
    *Start gathering general ideas for content; in this case I assume things like;

      *Information about BOINC, what it is, what it does etc.
      *How to install & use BOINC.


    *Start defining an information architecture, how all the various elements of the content are going to fit together; such as what sections are you going to have?
    *Establish content authoring guidelines for quality ausurance
    *Ideally have certain authors responsible for distinct areas, so that there's at least one person with a good overview of a section in order to maintain content as a coherient whole, rather than just odd pages stuck together - by this I mean the inter-linking of pages should make sense, and things should follow-on from each other.



I think that's enough to start with.


Want to search the BOINC Wiki, BOINCstats or various BOINC related forums from within firefox? Try the BOINC related Firefox Search Plugins
ID: 10802 · Report as offensive

Message boards : Documentation : Welcome

Copyright © 2019 University of California. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation.