openmainframeproject / openmainframeproject/cobol-programming-course
Improve the course on documentation
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- COBOL
- Stars
- 3.6k
- Forks
- 721
- Avg merge
- 11d 16h
- Merged PRs (30d)
- 1
Description
- What is the standard format of API-documentation (e.g. Javadoc)?
- Which API-documentation tool (e.g. Doxygen) is used?
- How API-documentation is usually managed?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue does not name a file, test, or course section. Begin by reviewing the course documentation structure and existing API-documentation material, then identify where the three questions belong. Done means the course clearly explains the standard format, tooling, and management of API documentation.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100