Ask Your Question
1

What is the state of documentation for askbot project?

asked 2012-02-28 03:33:34 -0500

Incheon gravatar image

updated 2012-02-28 23:06:23 -0500

What is the current state of documentation of askbot? I am referring to following:

  • Code Documentation
  • User Manual
  • Administration Manual
  • Installation Manual - I guess this is complete
edit retag flag offensive close merge delete

1 Answer

Sort by ยป oldest newest most voted
1

answered 2012-02-28 10:31:52 -0500

Evgeny gravatar image

updated 2012-02-28 10:33:09 -0500

Of the four you mentioned we do not have "user manual" and "administration manual" yet.

Ideally the software should be just simpler to use, so that the manuals would not be as necessary, or could be kept more concise. I'd rather spend the effort on this, rather than writing the manuals.

edit flag offensive delete link more

Comments

In order for people to contribute on a question/answer site in my view user manual is absolutely necessary with as much details as possible, supplemented with online help. Regarding code documentation I was referring more to the documentation which describes the specific design decisions, classes and the inner workings of the code so that it becomes easier for people to use. In my view since askbot uses django, the documentation standard for this project should also match that of django. It will be good to create a documentation as sub part of this project and invite contributors.

Incheon gravatar imageIncheon ( 2012-02-28 23:08:19 -0500 )edit

I'd rather have askbot be self-evident, than documented. That said the installation procedure and documentation are neither.

brycenesbitt gravatar imagebrycenesbitt ( 2012-03-04 23:24:20 -0500 )edit

Its impossible to have a good self-evident system for all common use cases, indeed the best user interface developers like apple also needs to be produce a very detailed documentation. As mentioned in my post earlier documentation is necessary for the success of this project. As its based on django I hope askbot should follow django example for documentation.

Incheon gravatar imageIncheon ( 2012-03-08 21:26:48 -0500 )edit

Your Answer

Please start posting anonymously - your entry will be published after you log in or create a new account.

Add Answer

Question Tools

Stats

Asked: 2012-02-28 03:33:34 -0500

Seen: 190 times

Last updated: Feb 28 '12