Getting better at custom app documentation
Options
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
04-08-2024 09:44 AM
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
Options
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
04-08-2024 10:51 AM
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