User Documentation
Registered by
Brian Curtin
Along with API documentation, user documentation is a necessary part of an SDK. This documentation is more in paragraph form, explaining how or why you'd do certain operations.
As with the examples, the general tone of this document should make no assumptions about internals. It can be useful to explain how things are implemented, providing a look at the internals, but such sections should be identified as advanced, and not used to build off for general documentation.
Blueprint information
- Status:
- Complete
- Approver:
- None
- Priority:
- Essential
- Drafter:
- Brian Curtin
- Direction:
- Needs approval
- Assignee:
- Brian Curtin
- Definition:
- Approved
- Series goal:
- Accepted for master
- Implementation:
-
Implemented
- Milestone target:
- None
- Started by
- Terry Howe
- Completed by
- Terry Howe
Related branches
Related bugs
Sprints
Whiteboard
I think this is done. We have bugs for resources that lack property documentation.
(?)
