Resources for preparing a formal specification document
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Go
- Stars
- 166
- Forks
- 44
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 13
Description
On today's Baseline call, I offered to provide some resources to the group for developing a formal specification draft. Below are a few stable links that we produced with Rex Jaesche and our PAS Application Manager, Seth Newberry:
- video - Writing a Formal IT Specification
- video - Writing a Formal IT Specification for Publication by ISO
- document - Companion Guide
- video - Preparing Your Project for ISO Submission
@bennetkl volunteered to assist / support on today's call as well! Please let either of us know if we can help in anyway!
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
Review the four linked specification resources and the issue discussion first. No repository file, test, or documentation location is named, and the issue does not define a repository change or completion criteria; an actionable scope would need to be clarified before implementation can begin.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100