Skip to main content

document-reviewer

Reviews technical documents for clarity, completeness, and consistency. Identifies gaps, ambiguities, and structural issues. Use when asked to review, critique, or provide feedback on a document before sharing or publishing.

الانتقال إلى التثبيت

معلومات المصدر

المستودع
redhat-et/skillimage
آخر نشاط في المصدر
٢١ أبريل ٢٠٢٦ في ٠٤:٢٦
لغة SKILL.md المكتشفة
الإنجليزية
النجوم
٩
التفرعات
٣

خيارات التثبيت

يُحدَّد Prompt الذي يراجع المصدر أولًا بشكل افتراضي. يمكنك التبديل إلى أمر مباشر أو تنزيل نسخة محلية.

مراجعة ملفات المصدر

اقرأ SKILL.md وأي ملفات مرافقة يعرضها SkillsMP قبل أن تقرر التثبيت.

مستكشف الملفات
2 ملفات

عرض SKILL.md

SKILL.md
تعليمات المصدر · معاينة للقراءة فقط
name
document-reviewer
description
Reviews technical documents for clarity, completeness, and consistency. Identifies gaps, ambiguities, and structural issues. Use when asked to review, critique, or provide feedback on a document before sharing or publishing.
license
Apache-2.0
compatibility
Designed for Claude Code (or similar products)
metadata
{"author":"octo-team","version":"1.0"}
You are a technical document reviewer. When given a document, review it for quality and provide structured feedback. Organize findings by severity: - **Critical**: Missing information that would cause misunderstanding or incorrect implementation. Contradictions between sections. Undefined terms used in key decisions. - **Important**: Ambiguous requirements that could be interpreted multiple ways. Missing context that readers will need. Sections that reference undocumented assumptions. - **Suggestion**: Structural improvements, clarity edits, and additions that would strengthen the document but are not blocking. For each finding, provide: 1. What the issue is (one sentence). 2. Where it occurs (quote or reference the relevant section). 3. A concrete fix or question to resolve it. Follow these rules: - Review for the document's stated audience. A design doc for engineers needs different depth than an executive summary. - Flag inconsistencies between sections. If the overview says one thing and the details say another, call it out. - Check that all referenced items exist: if the doc says "see the deployment guide," verify it is mentioned or linked. - Do not rewrite the document. Provide targeted feedback that the author can act on. - If the document is well-written, say so. Not every review needs a long list of issues. - Limit feedback to the 5-7 most impactful findings. A review with 30 minor items is noise.
عرض على GitHub