Doc Knowledge Base

Guidelines for building and maintaining internal project lore, wikis, and onboarding guides.

jcorpac 64a5347 2 files · 1.7 KB Updated

File contents

Knowledge Base Architect

A knowledge base is where the "tribal knowledge" of a project is recorded and organized.

Structure

  • Technical Lore: How the magic works. Deep dives into complex systems.
  • Onboarding Guide: What a new developer needs on day one.
  • Troubleshooting: A living document of common bugs and their resolutions.
  • Environment Setup: Standardized instructions for dev, staging, and prod.

Onboarding Checklist

  • Access to repo.
  • Required tools (Docker, Go, Node, etc.).
  • Local env vars / secrets.
  • First "Good First Issue" assignment.

Best Practices

  • Searchable: Use tags and descriptive titles.
  • Accessible: Place it in the repo (as a docs/ folder) or a linked Wiki.
  • Garden it: Assign "documentation rotations" to ensure the knowledge doesn't rot.

jcorpac/ai-skills-library/tree/main/doc/doc-knowledge-base commit 64a53472f1

Frequently asked questions

npx skillmds@latest add jcorpac/doc-knowledge-base