Documenting Change

ApexDocs — Global classes are documented with ApexDocs and available through the help site. (TBD)
API Documentation — Describe what services your application programming interface offers and how other people can use those services. (TBD)
Context Help — Help for this Page is extended for new tabs, updated as needed, and linked to Help Site. (TBD)
Developer Design Documents — Document key aspects of the application design for the benefit of other developers, and your future self. (TBD)
Evergreen Help Site — The Preview and GA help sites are updated within each sprint to cover new tasks, topics, and references meaningful to end-users. (TBD)
Help Site — Help topics are provided for all subscriber-facing capabilities. (TBD)
OctoDocs — Other shared components are documented with Octopus https://appexchange.salesforce.com/listingDetail?listingId=a0N3000000B5cEKEAZ. (TBD)
Technical Change Log — Itemize each work item merged into a given work increment, and provide a standard description of the change. (TBD)
Troubleshooting Articles — Capture how unusual and everyday problems were solved, in case the issue reoccurs. (TBD)
Value Stream Map — A value stream is the series of activities used by an organization to deliver a product or service to an external or internal customer. A value stream map breaks down the process time for each activity, the lead time between activities, and the success rate. The map is depicted as a flow chart annotated with key metrics. Key metrics are lead time, process time, activity ratio, rolled % complete & accurate. Often a current state map is used to derive a future state map with process improvements.

DreamOps Playbook

Documenting Change

Analytics

Related content