managing-docs
Organizar la documentación del proyecto
Los proyectos a menudo carecen de una estructura clara de documentación, lo que dificulta que usuarios y colaboradores encuentren información. Esta skill proporciona patrones de arquitectura probados, guías de configuración de herramientas y estándares para organizar documentación a cualquier escala.
스킬 ZIP 다운로드
Claude에서 업로드
설정 → 기능 → 스킬 → 스킬 업로드로 이동
토글을 켜고 사용 시작
테스트해 보기
"managing-docs" 사용 중입니다. Set up documentation structure for my Python project using MkDocs
예상 결과:
- Estructura recomendada: proyecto estándar con directorio docs/
- Archivos requeridos: README.md, CONTRIBUTING.md, CHANGELOG.md, LICENSE
- Plugins de MkDocs: search, autorefs para referencias cruzadas
- Navegación: Getting Started → Guides → API Reference → Contributing
- Tema: material con pestañas y navegación por secciones
- Flujo de trabajo de GitHub Actions incluido para despliegue automático
"managing-docs" 사용 중입니다. How should I organize docs for my JavaScript monorepo with 5 packages
예상 결과:
- Documentación raíz: visión de arquitectura, lista de paquetes, guías entre paquetes
- Documentación por paquete: README, referencia de API, guías específicas del paquete
- Contenido compartido: guía de contribución, guía de estilo, solución de problemas
- Estrategia de navegación: índice raíz con enlaces a cada sección de paquete
- Referencias cruzadas: usar autorefs de MkDocs o sidebars de Docusaurus
보안 감사
안전Pure prompt-based documentation skill containing only guidance patterns. All static findings are FALSE POSITIVES. Directory tree diagrams were misidentified as shell commands. Documentation tool names were misidentified as cryptographic algorithms. The skill has no executable code, no network calls, no file operations beyond standard Read/Write/Edit/Glob/Grep/Bash tool capabilities.
위험 요인
🌐 네트워크 접근 (3)
⚙️ 외부 명령어 (38)
품질 점수
만들 수 있는 것
Configurar documentación para un proyecto nuevo
Crear la estructura de documentación y configurar herramientas al iniciar un proyecto nuevo
Reestructurar documentación existente
Organizar documentación dispersa en una estructura coherente y navegable
Establecer estándares del equipo
Definir convenciones de documentación e integrar herramientas en los flujos de trabajo del equipo
이 프롬프트를 사용해 보세요
Set up documentation structure for my new [language/framework] project. Include directory layout, recommended files, and configuration for [MkDocs/Docusaurus/Sphinx/TypeDoc].
My project documentation is disorganized. Audit the current structure in [path] and suggest a reorganized layout based on the [simple/standard/large/monorepo] pattern.
Configure [MkDocs/Docusaurus] for my project. I need navigation for [sections], search functionality, and [any specific theme/feature requirements].
Design a documentation structure for a monorepo with [number] packages. Each package has [types of components]. Include shared docs strategy and cross-referencing approach.
모범 사례
- Empieza con las necesidades del lector: organiza la documentación según cómo los usuarios buscan información, no según la estructura interna del código
- Mantén los archivos de documentación enfocados: un tema por archivo con nombres claros y descriptivos usando guiones en minúsculas
- Vincula contenido relacionado: crea una red de referencias cruzadas entre guías conceptuales, tutoriales y documentación de referencia de API
피하기
- Poner toda la documentación en un solo archivo en lugar de dividirla en secciones enfocadas y navegables
- Incluir ejemplos de código que no se prueban ni se mantienen junto con el código base real
- Crear estructuras de carpetas profundamente anidadas que dificultan encontrar información