Getting better at custom app documentation

LearnUseThrive
Mega Sage

I want to get better at documenting the custom applications and other functionality that we build at my company. Does anyone have an example of release notes or app documentation? I think I know the kinds of information that I want to include, but I'm a little stuck on how to format it. 

1 REPLY 1

jonsan09
Giga Sage
Giga Sage

It really depends on who your target audience is (customer vs other developers). Here is a starting format that I usually use:

--Overview--
Application: 
Scope: 
Original developer: 
App Owner(s): 
Original Release & Change: 
Relevant Records
•	Some link to a Stories and other docs
 
--Development Information--
Diagram
     Some process flow/diagram here

--Component Details--
Tables
o	Table 123
Roles
•	Roles123
o	what role has access to/explanation