Where does Documentation fit In?
This is continuation of a subject started in the Forum:
I'm amazed some days with what you can accomplish using Open Source software. I've found since I started building Joomla! based websites, that one of keys between a "perfect" install, and a "throw it away in trash can" install/removal is that there are 2 things that make a difference in my final result.
If I have problems with the install, I:
1) find a solution in the Documentation for the software.
2) Search the software's Forum, and get feedback/answers/solutions for the Forum Community.
Not being able to find a solution in the documentation, or not getting any feedback from the community (lack of interest, no developer support, low or no forum activity) will dampen my enthusiasm for using that software. Many times, I move onto the next choice of plugin, module, or component on my list of candidates for my website needs.
Not only does documentation need to written for the "back end" users, but also for the "front end" users. Documentation Team members seem to be the ones who "fit in the middle" of the technical and the content editor/builders sides of the Development end of software.
I'm amazed some days with what you can accomplish using Open Source software. I've found since I started building Joomla! based websites, that one of keys between a "perfect" install, and a "throw it away in trash can" install/removal is that there are 2 things that make a difference in my final result.
If I have problems with the install, I:
1) find a solution in the Documentation for the software.
2) Search the software's Forum, and get feedback/answers/solutions for the Forum Community.
Not being able to find a solution in the documentation, or not getting any feedback from the community (lack of interest, no developer support, low or no forum activity) will dampen my enthusiasm for using that software. Many times, I move onto the next choice of plugin, module, or component on my list of candidates for my website needs.
Not only does documentation need to written for the "back end" users, but also for the "front end" users. Documentation Team members seem to be the ones who "fit in the middle" of the technical and the content editor/builders sides of the Development end of software.
Views: 1
Replies to This Discussion
-
Permalink Reply by Oleg Nesterov on -
You're absolutely right. What we have is a huge number of programs/extensions/whatever, but a few of them have a good documentation. Being a develop I must admit that the user-end documentation is the hardest part in our work. There is always a lack of time to do it. However having a good written documentation definitely opens the software to a larger number of people. Maybe developers should focus on this part firstly rather then fixing bugs and releasing new versions. What do you think?
-
-
Permalink Reply by Mark W. Bender on -
Documentation should really be considered a part of the whole software package. Look at the extensive documentation that is available for autos. The Free version comes with the car (you have to pay for car), the paid documentation (book) you buy at the car part store provides more details. The very detailed manuals are used by mechanics, and cost more!
Having found Joomla 18 months ago, the project is steadily moving forward in scope with the release of Joomla! 1.6 in the upcoming year. Think of 1.5 as a rail car at the local train station, and you (the documentation) are trying to catch a "moving target". Very difficult to catch a moving target in either circumstance. The greater the time difference between the software and the documentation, the harder it is for users to find the answers to their questions. -
© 2012 Created by Amy Stephen.
