bcgov / bcgov/entity

Retro 29.2 and 29.3 Improve Documentation Standards for BC Registries Application

Open
#33,401 3 comments 0 reactions 3 assignees Claimed by @nsmenon8890 View on GitHub
Names Team
Dominant language
JavaScript
Stars
23
Forks
62
Avg merge
24m
Merged PRs (30d)
1

Description

**Description**

There is currently no consistent documentation standard across the BC Registries application, which makes onboarding, troubleshooting, and knowledge sharing difficult.

This ticket is to define simple documentation standards/templates and identify key documentation gaps so information is easier to maintain and access across the team.

**Acceptance Criteria**

- [ ] Define basic documentation standards/templates
- [ ] Identify major documentation gaps
- [ ] Align on ownership and maintenance expectations
- [ ] Share/document where documentation should be stored

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.