Uploaded image for project: 'CiviCRM'
  1. CiviCRM
  2. CRM-257

Developer Documentation for the CiviCRM Code Framework

          Details

          • Type: Task
          • Status: Done/Fixed
          • Priority: Major
          • Resolution: Fixed/Completed
          • Affects Version/s: None
          • Fix Version/s: Unscheduled
          • Component/s: None
          • Labels:
            None

            Description

            We need to take a first pass at documentation of our framework, in order to:

            • provide a training resource for new developers (team members and contributors)
            • help ensure consistent and optimum use of the framework as new modules are developed

            Recommend creating a fairly detailed topic outline and solicit feedback from the team. Then following up w/ fleshing out a few of the topics (setting a model for format, level of detail, etc.). Might also be good to solicit (and present) any existing examples of this type of doc that we would want to use as a model.

            Once this is done, additional sections can be assigned to various team members (to 'share the wealth').

            Placeholder TOC page has been created at:
            http://objectledge.org/confluence/display/CRM/CiviCRM+Code+Framework

              Attachments

                Activity

                  People

                  • Assignee:
                    shot Piotr Szotkowski
                    Reporter:
                    dgg David Greenberg
                  • Votes:
                    0 Vote for this issue
                    Watchers:
                    0 Start watching this issue

                    Dates

                    • Created:
                      Updated:
                      Resolved: