المهارات doc-writer
📝

doc-writer

آمن

Generate task documentation from templates

متاح أيضًا من: 0xhiroki

Manual documentation takes time and often becomes outdated. This skill automates creation of numbered task docs using templates and repository context, ensuring consistent structure and accurate references.

يدعم: Claude Codex Code(CC)
⚠️ 68 ضعيف
1

تنزيل ZIP المهارة

2

رفع في Claude

اذهب إلى Settings → Capabilities → Skills → Upload skill

3

فعّل وابدأ الاستخدام

اختبرها

استخدام "doc-writer". Create a new task document for user authentication feature using DOC_TEMPLATE.md

النتيجة المتوقعة:

  • • Document created at docs/planned/03-user-authentication.md
  • • Metadata block includes task number, status, and date
  • • Objective section describes authentication goals
  • • Prerequisites list dependencies and requirements
  • • Implementation steps reference existing auth modules
  • • Validation section defines acceptance criteria

التدقيق الأمني

آمن
v3 • 1/10/2026

Pure prompt-based skill containing only documentation guidelines. No executable code, no network calls, no file system access, no external commands. This is a configuration file that instructs an AI how to write documentation using repository templates and context.

1
الملفات التي تم فحصها
26
الأسطر التي تم تحليلها
0
النتائج
3
إجمالي عمليات التدقيق
لا توجد مشكلات أمنية
تم تدقيقه بواسطة: claude عرض سجل التدقيق →

درجة الجودة

38
الهندسة المعمارية
100
قابلية الصيانة
83
المحتوى
32
المجتمع
100
الأمان
70
الامتثال للمواصفات

ماذا يمكنك بناءه

Maintain consistent task tracking

Generate standardized task documents that track planned and completed work across your project.

Enforce documentation standards

Ensure all tasks follow the same structure with proper metadata, objectives, and completion criteria.

Document implementation details

Create implementation step documentation with validation criteria and reference links to existing code.

جرّب هذه الموجهات

Create new task doc
Create a new task document for [task name] in docs/planned/ using DOC_TEMPLATE.md. Number it sequentially after existing tasks and include context from PLAN.md.
Mark task complete
Move task [task-name] from docs/planned/ to docs/completed/ and update the document to reflect what was actually implemented.
Refresh stale doc
Review and update the task document at [path] to reflect current repository state, tests, and tooling requirements.
Generate from context
Generate a complete task document for [feature] using DOC_TEMPLATE.md. Gather context from PLAN.md, AGENTS.md, and relevant source files. Link to existing code rather than duplicating.

أفضل الممارسات

  • Always read DOC_TEMPLATE.md first to ensure proper structure
  • Link to existing code files instead of copying large excerpts
  • Verify acceptance criteria match current repository state
  • Use unique two-digit prefixes to avoid naming conflicts

تجنب

  • Creating docs without checking existing numbering sequence
  • Duplicating large code blocks instead of linking to source
  • Skipping the metadata block or required template sections
  • Failing to validate against DOC_TEMPLATE.md structure

الأسئلة المتكررة

What templates are required for this skill to work?
DOC_TEMPLATE.md must exist in the docs/ directory with the expected structure including metadata, sections, and formatting.
What file naming format is enforced?
Files must use the format NN-task-name.md where NN is a unique two-digit number and the name is lowercase with hyphens.
Can I integrate this with my CI/CD pipeline?
This skill runs within your AI assistant. You can add validation steps to your pipeline that check docs/ structure.
Does this skill modify existing files?
Yes, it can update existing task documents when moving from planned to completed or refreshing stale documentation.
What happens if numbering conflicts occur?
The skill attempts to find the next available unique number, but you should verify numbering consistency manually.
How is this different from a documentation generator?
This skill follows a specific template and naming convention for task tracking rather than generating general API docs.

تفاصيل المطور

المؤلف

0xhiroki

الترخيص

MIT

مرجع

main

بنية الملفات

📄 SKILL.md