Recent Topics

Where is the documentation?

Started by on Dec 27, 2004 – Contents updated: Dec 27, 2004

Dec 27, 2004 19:06    

In case you haven't found them on the website, there are two documentation areas besides this forum:

The user manual: http://b2evolution.net/man/ which is written by volunteers. Please speak up here if you want to contribute ;)

The technical/developer documentation: http://doc.b2evolution.net/ - This one is generated automatically from the source code.

Dec 28, 2004 17:57

At this time, the 'volunteer' doc is just a list of all the doc that is written.
Could it be possible to place a right column with the last written posts in it.
Something like you 'news' section.
Handy for regular visitors

Apr 18, 2005 21:02

Coming from the corporate world as a manager for enterprise software projects, I am big on documentation and FAQs. Like everyone else, I am short on time but I know this can be done. A lack of documentation hurts the popularity of this excellent program, so here is what I propose.

I am starting my own online FAQ, using [url=http://www.technetguru.net/design/faqmasterflex.php]FaqMasterFlex[/url]

I will make this database available to anyone who wants to use it or they can point to my [url=http://blogs.gentle.net/faq]FAQ database[/url]. When this url changes, I'll edit this post to reflect that change.

Putting the information in a different database avoids mods that might have to be changed later. Additionally, the info "could" be imported into something else at a later date.

I'll offer to maintain the information in the database. If someone wants to assist in this endeavor, send your information to me in the following format.
--------------------------------------------

Email should be sent to BlogDoc@gentle.net

The title of the email for content submissions should be FAQ Entry

Email should be broken down into three sections:

Category - (choose an existing category or recommend a new one

Question - A one line question related to the category

Answer - simple HTML formatting is acceptable.

--------------------------------------------

Commitment

    I will try to add the new data within 24 hours. Submissions failing to adhere to the documented format will be discarded without consideration or notification.

    I will make the database available for download.

    I will keep my software updated to ensure security and functionality.

    I will place a small B2evolution graphic on the page with a link to this site.

    I will do all that is in my power to ensure a stable product and that it is accessible, but things happen.

    I will create and maintain a section for people new to blogging, geared toward b2evolution.

    I will make sure the categories are organized and consistent with the effort, creating new one only when necessary.
    [/list:u]
    Disclaimers

      I reserve the right to change the look and feel of my presentation to suit my needs, but will try to keep it a simple FAQ application. (No major banner ads, etc.) unless someone else wants to take over.

      Installing [url=http://www.technetguru.net/design/faqmasterflex.php]FaqMasterFlex[/url]
      is the responsiblity of those wishing to have a stand-alone app they can modify.

      The details of this offer are subject to change when change is deemed necessary. Yes, that's an arbitrary statement, but that's the best I can do for now.

      [/list:u]

      In short, I am working on documentation and will share it with the community. The format may not be what some people want, but it's quite usable and easily integrated. Just add a link to the admin section.

      Comments? Recommendations? Anyone want a mint? :)

      - Rod

Apr 19, 2005 02:20

I agree that the documentation for b2e is confusing in its current state. There are too many odd places you have to look to find the information you need, and far too many dead ends.

However, it might be a good idea right now to just get the framework for a documentation site up and running because I get the feeling when the next version comes out a lot of new documentation is going to be needed. It might not be a good idea to spend a lot of time right now writing or copying faqs if it's all going to need updating when the next version is released.

Apr 20, 2005 02:53

I agree. When the new version is released, much of this will have to be rewritten, but there will be many people who will continue using the current version.

I've played with the CVS version and it looks GOOD even though it is obviously a work in progress. It shows the promise of the future for this already excellent program.

I am working to provide what I need to take care of the people I support. Sharing it with the community is the least I can do. I know my choice of software may not be the best, but its data architecture lends itself to importation later, with little headache.

I am not criticizing what we have so far in the way of documentation, but much of it is buried in the message base. Most neophytes I know would not search for what they need here.

Apr 14, 2007 02:55

fplanque wrote:

In case you haven't found them on the website, there are two documentation areas besides this forum:

The user manual: http://b2evolution.net/man/ which is written by volunteers. Please speak up here if you want to contribute ;)

The technical/developer documentation: http://doc.b2evolution.net/ - This one is generated automatically from the source code.

Hello Francois,

I am just becoming acquainted with your outstanding efforts to keep alive, support, and grow the b2evolution application. You have really done a remarkable job!

However, my first impressions were also flavored with a bit of disappointment about the quality of the documentation, and the rather historical nature of the posting activity on this subject.

If it would be of use to you, I have some time and resources to apply to the documentation effort. However, as an experienced professional software developer, I am not comfortable with, interested in, and perhaps not even qualified to produce professional user oriented documentation of the application.

On the other hand, it might benefit both of our interests if you think that moving the technical documentation of the underlying software away from that produced by simple coding comments would help. New technical documentation would provide a more formal, and integrated set of references for both the software developers and the maintainers of the system.

If you're interested please let me know.

Best Regards....Bob Lennon

Apr 14, 2007 03:40

I imagine more help would be appreciated, especially if it's geared towards helping users delve into the technical side of b2e.

But from the quote you used, are you aware of the wiki manual? http://manual.b2evolution.net/. You're certainly welcome to share in the efforts there.

Apr 14, 2007 08:28

Nate wrote:

I imagine more help would be appreciated, especially if it's geared towards helping users delve into the technical side of b2e.

But from the quote you used, are you aware of the wiki manual? http://manual.b2evolution.net/. You're certainly welcome to share in the efforts there.

Thank you for the tip Nate, and although I've dug into most of the existing documentation, I've found it difficult as a newcomer to this forum to navigate through much of the information, wiki or not.

My selection of the post to quote is probably a good example.:roll:

Perhaps you could give me a short heads up on how the documentation effort is organized, what the objectives are, and who the players are?

Best Regards...Bob Lennon

Apr 14, 2007 14:28

I'm under the impression that the wiki manual (http://manual.b2evolution.net/) is the primary place to put any and all documentation relating to b2e....That's why it is linked from the tabs at the top of each b2e website page (see "Docs" above).

http://doc.b2evolution.net/ is generated directly from the source code and is somehow useful to the developers. It's not an area that I spend any time in.

http://b2evolution.net/man/ is the old manual. It was terribly difficult to navigate and update, so the wiki was an attempt to replace it. It's basically obsolete and completely preserved or updated in the newer wiki.

In my understanding, which is not official, the wiki is the focal point of any and all documentation, whether it's aimed at the end-user or at developers.

The basic b2e users manual (in the wiki) is completed. It mostly needs updating as new versions come out, and as frequently asked questions from the forums are answered and need a more accessible home.

The biggest work being done on the development side is documenting plugins and how to use them or write them.

As far as "who the players are", there are four or five users who have helped fill in most of the pages, plus francois and blueyed who are the primary developers, and a few others who have added things here and there.

The wiki has open registration, and then you can dive right in. There's no fear of messing it up since it's easy to revert back if any mistakes are made.

I hope this helps... :-)

Apr 14, 2007 20:19

Nate wrote:

I'm under the impression that the wiki manual (http://manual.b2evolution.net/) is the primary place to put any and all documentation relating to b2e....

In my understanding, which is not official, the wiki is the focal point of any and all documentation, whether it's aimed at the end-user or at developers...

I hope this helps... :-)

Thank you for your prompt and informative reply Nate.

Under the circumstances, I don't feel comfortable with providing detailed technical information within a wiki that allows non-technical users to modify the document.

I also do not support the idea that technical references are best served to the development community through this medium.

Perhaps I'll just write it for my own education. Who knows, it might even qualify as a member of O'Reillys "Missing Manual" series.

Thanks again for your help.

Best Regards...Bob Lennon

Jan 24, 2008 11:25

Is there a place to download the documentation for offline use?

Thanks
Luke

Jan 24, 2008 16:20

I had posted, earlier today, some information suggesting that Luke might want to use a utility to download the manual to his desktop.

SCRATCH THAT. Posting back for anyone "watching this topic" to say that links do not work in the copy I just downloaded as a test. I just deleted that earlier post.

I will reiterate from the deleted post only this bit:

The b2evoultion manual is a wiki, a community effort that is a "living document" subject to continuous corrections and improvements. It is best to use it online to avail yourself of the most up-to-date information.

kazar


Form is loading...

CMS software – This forum is powered by b2evolution CMS, a complete engine for your website.