Skip to content

docs(contributing): add documentation structure guidelines for ecosystem#306

Merged
kcenon merged 1 commit into
mainfrom
docs/issue-305-documentation-guidelines
Jan 24, 2026
Merged

docs(contributing): add documentation structure guidelines for ecosystem#306
kcenon merged 1 commit into
mainfrom
docs/issue-305-documentation-guidelines

Conversation

@kcenon

@kcenon kcenon commented Jan 23, 2026

Copy link
Copy Markdown
Owner

Closes #305

Summary

  • Add standardized documentation structure guidelines for all KCENON ecosystem systems
  • Create document templates for consistent documentation across projects
  • Update docs/README.md with links to new guidelines

Changes

New Files

File Purpose
docs/contributing/DOCUMENTATION_GUIDELINES.md Main guidelines document defining folder structure, naming conventions, and compliance checklists
docs/contributing/templates/ARCHITECTURE_TEMPLATE.md Template for system architecture documents
docs/contributing/templates/FEATURE_TEMPLATE.md Template for feature documentation
docs/contributing/templates/GUIDE_TEMPLATE.md Template for user-facing guides

Modified Files

File Changes
docs/README.md Added links to new guidelines and templates in Contributing section

Guidelines Content

The documentation guidelines cover:

  • Required documents for every system (README, ARCHITECTURE, API_REFERENCE, FEATURES, CHANGELOG, PROJECT_STRUCTURE)
  • Standard folder structure (docs/, docs/advanced/, docs/guides/, docs/performance/, docs/contributing/)
  • Naming conventions (UPPER_CASE.md for core docs, .kr.md for Korean translations)
  • Translation requirements (English primary, Korean translations required for core docs)
  • Compliance checklist for pre-submission verification
  • Migration guide for systems with non-standard structure

Test Plan

  • Build succeeds (cmake --build)
  • All 113 tests pass (ctest)
  • All internal documentation links are valid
  • Guidelines document follows its own structure recommendations

Create standardized documentation guidelines that define the official
organization pattern for all KCENON ecosystem systems, ensuring
consistency across projects.

- Add DOCUMENTATION_GUIDELINES.md with folder structure, naming
  conventions, and compliance checklists
- Add ARCHITECTURE_TEMPLATE.md for system architecture documents
- Add FEATURE_TEMPLATE.md for feature documentation
- Add GUIDE_TEMPLATE.md for user-facing guides
- Update docs/README.md with links to new guidelines and templates

Closes #305
@kcenon kcenon merged commit 4a39e44 into main Jan 24, 2026
24 checks passed
@kcenon kcenon deleted the docs/issue-305-documentation-guidelines branch January 24, 2026 00:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: Create documentation structure guidelines template for ecosystem

1 participant