View · Index

Weblog

Filtered by date 2017-06-24, 1 - 3 of 3 Postings (all, summary)

toc-test-page

Created by Benjamin Brink, last modified by Benjamin Brink 24 Jun 2017, at 08:09 AM

some text..

some text..

 

Documentation History

Created by OpenACS community, last modified by Benjamin Brink 24 Jun 2017, at 05:19 AM

The history of OpenACS documentation: ..began by building on a good documentation base from ArsDigita's ACS in the late 1990's. The ACS documentation was largely written in docbook. Some sections of the documentation, however, lacked details and examples; others simply did not exist. The OpenACS community began meeting the challenge by identifying needs and writing documentation on an as needed basis.

By having documentation dependent on volunteers and code developers, documentation updates lagged behind the evolving system software. As significant development changes were made to the system, existing documentation became dated, and its value significantly reduced. The valiant efforts that were made to keep the documentation current proved too difficult as changes to the system sometimes had far-reaching affects to pages throughout the documentation. System integration and optimization quickly rendered documentation obsolete for developers. The code became the substitute and source for documentation.

There are many thousands of lines of code, and few developers tracking changes and publishing the changes. Subsequently features and advances to the OpenACS system went unnoticed or were not well understood except by the code authors. Work was duplicated as a consequence of developers not realizing the significant work completed by others. New developers had to learn the system through experience with working with it and discussion in the forums. Informal sharing of experiential and tacit knowledge has become the OpenACS community's main method of sharing knowledge.

Around 2006, efforts were made to build a consensus in new ways to overcome existing documentation limitations. Like most any diverse community, a consensus could not be reached. Time has distilled efforts into three approaches that augment OpenACS' primary source of documentation: OpenACS code itself.

Documentation Project

Created by Robert Taylor and Ryan Gallimore, last modified by Benjamin Brink 24 Jun 2017, at 04:21 AM

The managing of OpenACS documentation has evolved a few different ways. Instead of working on a unified consensus in managing the OpenACS documentation, there are primarily three efforts:

Approach 0: Continue updating docbook documentation via CVS (for those with access to CVS).

Approach 3: en:New_Documentation_Process is migrating the original OpenACS docbook docs to an xowiki instance.

Approach 4: en:Documentation_Project_Plan is building new documentation based on how the brain likes to chunk using subsystems. 

See en:Documentation_Project_Discussion for current status.

previous June 2017 next
Sun Mon Tue Wed Thu Fri Sat
28 29 30 31 (2) 1 (3) 2 3
4 5 (2) 6 (5) 7 8 9 10
(1) 11 12 (3) 13 14 (1) 15 (2) 16 (2) 17
(4) 18 19 (2) 20 21 (2) 22 23 (3) 24
25 26 27 (1) 28 (26) 29 (40) 30 1

Popular tags

17 , 5.10 , 5.10.0 , 5.9.0 , 5.9.1 , ad_form , ADP , ajax , aolserver , asynchronous , bgdelivery , bootstrap , bugtracker , CentOS , COMET , compatibility , CSP , CSRF , cvs , debian , docker , docker-compose , emacs , engineering-standards , exec , fedora , FreeBSD , guidelines , host-node-map , hstore
No registered users in community xowiki
in last 30 minutes
Contributors

OpenACS.org