mcpField
K
kb-creator

kb-creator

github.com/juancruzrobledoDocuments154 installsUpdated 22w ago
Repository

About kb-creator

kb-creator is a skill for building structured, navigable project knowledge bases from source documents or from scratch. It selects a silent ingest or interactive workflow based on the repository’s docs/ and knowledge-base/ contents, then produces a defined set of canonical files.

Key features

  1. 01Detect ingest or from-scratch mode
  2. 02Organize docs/ sources into a canonical knowledge base
  3. 03Guide new documentation through strategic questions
  4. 04Create 10 canonical files and an index README

Use cases

  1. 01Turn long project documents into a topic-based knowledge base
  2. 02Organize project information from existing docs/ files
  3. 03Map goals, architecture, and open questions from scratch

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/juancruzrobledo/kb-creator --skill kb-creator

After installing, type/kb-creatorin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

README.md
assets/
strategic-questions.md
state-contract.md
canonical-templates.md

Details

From the project README

When to Use

  • Generar una base de conocimiento estructurada y navegable para un proyecto.
  • Convertir documentos monolíticos (.txt, .docx, .pdf, .md largos) en una KB temática.
  • Documentar un sistema desde cero acompañando al usuario como socio estratégico.

Don't use when:

  • Ya existe knowledge-base/ con los 10 archivos canónicos completos (sugerí actualizar archivos puntuales en su lugar).
  • El usuario pide UN documento específico (es una skill de KB completa, no de archivos sueltos).

Operating Modes

Esta skill auto-detecta el modo al iniciar:

Mode A — From existing source docs (silent)

Trigger automático: la carpeta docs/ existe y contiene archivos fuente (.txt, .docx, .pdf, o .md distintos a un README).

Comportamiento: leés todas las fuentes desde docs/, analizás, y generás la KB canónica completa en knowledge-base/ (raíz del proyecto) sin hacer preguntas. Fire-and-forget.

Mode B — From scratch (interactive)

Trigger automático: la carpeta docs/ no existe, está vacía, o solo tiene un README, y knowledge-base/ no existe en raíz. Trigger explícito: el usuario dice "armemos desde cero", "construyamos la KB", "no tengo documentación previa".

Comportamiento: actuás como socio estratégico — analizás contexto, detectás huecos, hacés 3-5 preguntas estratégicas, proponés enfoques con pros/contras, iterás archivo por archivo con validación.


Critical Patterns

Output location (ambos modos)

Todos los archivos de la KB van a knowledge-base/ en la raíz del proyecto. NUNCA mezclar con docs/ (que contiene los documentos fuente).

Canonical files (10 obligatorios)

La KB DEBE contener estos 10 archivos con estos nombres exactos:

#ArchivoContenido
0101_vision_y_objetivos.mdPropósito, objetivos por actor, alcance, fuera de alcance
0202_descripcion_general.mdStack tecnológico, arquitectura general, integraciones externas
0303_actores_y_roles.mdActores del sistema, tabla RBAC, permisos, rutas públicas
0404_modelo_de_datos.mdEntidades, ERD, relaciones, seed data
0505_reglas_de_negocio.mdReglas codificadas por dominio (con códigos tipo RN-XX)
0606_funcionalidades.mdHistorias de usuario / features organizadas por épica
0707_flujos_principales.mdFlujos extremo a extremo (auth, dominio principal, etc.)
0808_arquitectura_propuesta.mdPatrones, estructura de directorios, seguridad, env vars
0909_decisiones_y_supuestos.mdDecisiones de diseño documentadas + supuestos inferidos
1010_preguntas_abiertas.mdInconsistencias detectadas + preguntas abiertas priorizadas

Más un README.md índice en knowledge-base/README.md.

Ver assets/canonical-templates.md para la estructura interna esperada de cada archivo.

Optional extras (permitidos)

Si el dominio lo requiere, podés agregar archivos extra con prefijo 1X_ o 2X_ y nombre kebab-case. Ejemplos:

  • 11_pagos_mercadopago.md (e-commerce con pasarela específica)
  • 12_devops_y_despliegue.md (proyecto con infra compleja)
  • 13_observabilidad.md (sistema con telemetría no trivial)

Los extras nunca reemplazan los 10 canónicos — los complementan.

Mode A workflow (silent)

Mode A → source: "ingest" (see State integration below)

  1. glob docs/*.{txt,docx,pdf,md} — enumerá las fuentes (excluí README).
  2. Leé todas las fuentes.
  3. Para cada archivo canónico, extraé contenido relevante de las fuentes y estructuralo siguiendo assets/canonical-templates.md.
  4. Si una fuente cubre dominios extra (ej. pagos con un PSP específico), creá un archivo extra 1X_*.md.
  5. Escribí los 10 canónicos + extras + README.md.
  6. Cerrá con una tabla resumen: archivo → líneas → temas cubiertos.
  7. Si orquestado: inferí los 6 campos discovery de los docs generados y ejecutá el hook de estado (ver assets/state-contract.md §4). Fuente: "ingest".

No hagas preguntas en este modo. Si una fuente es ambigua, registrá la duda en 10_preguntas_abiertas.md y seguí. Si un campo discovery no puede inferirse con confianza, registrá la incertidumbre en 10_preguntas_abiertas.md — nunca inventes un valor.

Mode B workflow (interactive)

Mode B → source: "interactive" (see State integration below)

  1. Analizá contexto disponible (nombre del repo, mensaje del usuario, archivos visibles).
  2. Resumí en un párrafo qué entendés del proyecto.
  3. Listá las incertidumbres principales (3-5).
  4. Proponé 2-3 enfoques iniciales con pros y contras.
  5. Hacé las 3-5 preguntas estratégicas (ver assets/strategic-questions.md), incluyendo las preguntas de discovery P0-sys y P0-scale que mapean a system_type y scale.
  6. Esperá respuesta del usuario antes de generar archivos.
  7. Después, proponé estructura inicial de la KB y validá.
  8. Iterá archivo por archivo, escribiendo + pidiendo feedback.
  9. Si orquestado: registrá los 6 campos discovery de las respuestas del usuario y ejecutá el hook de estado (ver assets/state-contract.md §4). Fuente: "interactive".
Tono según modo
  • Mode A: eficiente, factual, sin floreos.
  • Mode B: arquitecto senior + product manager. Cuestiona decisiones débiles. Marcá supuestos con **Suposición:**. Proponé alternativas. Detectá riesgos.

State integration (orchestrated)

Este hook es condicional y standalone-safe: se ejecuta solo si .jr-orchestrator-state.json ya existe en la raíz del proyecto (run orquestado por jr-orchestrator). Si el archivo no existe, el comportamiento es idéntico al de hoy — ningún archivo de estado es creado.

Cuándo corre: inmediatamente después de escribir knowledge-base/ (último paso del workflow, antes de retornar al usuario).

Qué escribe: solo state.kb — nunca toca step, owner, roadmap, skills, ni agents.

Mode → source mapping:

Modostate.kb.source
Mode A (silent, desde docs/)"ingest"
Mode B (interactive, desde cero)"interactive"
Mixed runs: si el run comenzó desde docs/ (trigger Mode A), resuelve a "ingest" aunque se hayan completado huecos con preguntas. El origen dominante determina source.

Algoritmo completo, reglas de inferencia para Mode A y low-confidence rule: ver assets/state-contract.md.


Code Examples

Mode A: tabla resumen al cerrar
## KB generada en knowledge-base/

| Archivo | Líneas | Temas cubiertos |
|---------|--------|-----------------|
| 01_vision_y_objetivos.md | 84 | Propósito, 3 actores, alcance v5.0 |
| 02_descripcion_general.md | 132 | FastAPI + React, REST, 14 endpoints |
| ...
Mode B: pregunta estratégica modelo
**Pregunta 2 de 4 — Alcance del MVP**

¿Cuál es el alcance MÍNIMO viable para considerar el sistema "lanzable"?

- (a) Solo flujo de compra (catálogo + carrito + checkout simulado).
- (b) Flujo completo con pago real integrado.
- (c) Pago + panel admin con métricas.

**Por qué importa**: define qué entra en la primera versión y qué se posterga. Una respuesta vaga acá te genera scope creep en sprint 2.

Commands

# Instalar la skill
npx skills add https://github.com/JuanCruzRobledo/kb-creator

# Invocar en el agente (carga automática por contexto):
"crear base de conocimiento del proyecto"
"generar KB desde los docs"
"armemos la documentación desde cero"

Resources

  • Templates: ver assets/canonical-templates.md — estructura interna esperada de los 10 archivos canónicos.
  • Strategic questions: ver assets/strategic-questions.md — banco de preguntas para Mode B (incluye P0-sys y P0-scale para discovery orquestado).
  • State contract: ver assets/state-contract.md — schema slice state.kb, algoritmo de escritura condicional, reglas de inferencia Mode A, low-confidence rule.

Comments

Markdown supported