Document Decisions and Architecture Clearly
Teams lose context when important technical decisions remain in chat, code comments, or individual memory. This skill turns architectural reasoning, API guidance, project instructions, and release changes into structured documentation.
انسخ هذا الطلب إلى Agent لديك. يتضمن صفحة Skill المعتمدة وملف manifest.
Review the Skillstore skill "documentation-and-adrs" from https://skillstore.io/skills/addyosmani-documentation-and-adrs.md and its manifest at https://skillstore.io/api/skills/addyosmani-documentation-and-adrs/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.يجب أن يواصل Agent عرض خطته وطلب أي تأكيد تفرضه سياسة الأمان.
استخدم هذه الروابط عندما يحتاج AI Agent أو crawler أو script إلى سياق نظيف بدلًا من قراءة الصفحة كاملة.
جارٍ استخدام "documentation-and-adrs". We chose PostgreSQL over SQLite and MongoDB for a multi-user task application.
النتيجة المتوقعة:
An ADR outline with status, context, relational data requirements, alternatives considered, the PostgreSQL decision, and operational consequences.
جارٍ استخدام "documentation-and-adrs". Document a task creation endpoint that requires a title and returns an identifier.
النتيجة المتوقعة:
API reference guidance covering the request fields, validation errors, authentication expectations, response details, and a short usage example.
جارٍ استخدام "documentation-and-adrs". Create onboarding documentation for a project with a development server and test suite.
النتيجة المتوقعة:
All 28 external-command detections are Markdown examples or inline command references in SKILL.md, not executable behavior. The environment-file and system-reconnaissance detections also point to documentation examples, and no prompt injection or data-exfiltration intent was found.
شارك تقرير التقييم المرتبط بالإصدار والشارة المحايدة وبطاقة التضمين والاستشهادات. تعرض Skillstore الأدلة من دون أن تقرر ما إذا كانت هذه المهارة آمنة.
https://skillstore.io/skills/addyosmani-documentation-and-adrs/audits/2?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report[](https://skillstore.io/skills/addyosmani-documentation-and-adrs?utm_source=security_passport_badge)<a href="https://skillstore.io/skills/addyosmani-documentation-and-adrs?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/addyosmani-documentation-and-adrs/security.svg" alt="Skillstore security assessment" loading="lazy"></a><iframe src="https://skillstore.io/embed/skills/addyosmani-documentation-and-adrs.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>addyosmani. (2026). documentation-and-adrs security audit report (audit version 2) [Author version unspecified]. Skillstore. https://skillstore.io/skills/addyosmani-documentation-and-adrs/audits/2@techreport{addyosmani-addyosmani-documentation-and-adrs-2026,
author = {addyosmani},
title = {documentation-and-adrs security audit report (audit version 2)},
institution = {Skillstore},
year = {2026},
number = {2},
url = {https://skillstore.io/skills/addyosmani-documentation-and-adrs/audits/2},
note = {Author version unspecified}
}cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "documentation-and-adrs security audit report (audit version 2)"
version: "unspecified"
type: report
authors:
- name: "addyosmani"
date-released: "2026-09-19"
url: "https://skillstore.io/skills/addyosmani-documentation-and-adrs/audits/2"
identifiers:
- type: other
value: "skillstore:addyosmani-documentation-and-adrs:audit:2"
description: "Skillstore immutable audit report identifier"
Create an ADR that compares options, explains trade-offs, records the selected approach, and preserves consequences for future maintainers.
Draft consistent API documentation covering inputs, outputs, errors, authentication expectations, and representative usage guidance.
Build a practical README, changelog structure, and agent guidance so contributors can understand setup, architecture, conventions, and recent changes.
Create a concise ADR for this decision: [decision]. Include context, selected approach, two alternatives, consequences, status, and date. Use clear headings.
Review the repository context I provide and identify its ADR location, file format, numbering pattern, and headings. Then draft an ADR for [decision] that follows those conventions.
Write documentation for this public API: [API details]. Cover parameters, return values, validation, authentication, errors, and one realistic example. State unknowns instead of inventing behavior.
Design a documentation update for [project]. Propose ADRs for durable decisions, README sections for onboarding, API reference coverage, changelog entries, agent guidance, and a verification checklist. Preserve existing conventions and identify missing evidence.
المؤلف
addyosmaniالترخيص
MIT
مراجعة Skillstore
r2
تنبيه الإصدار
لم يعلن المؤلف عن إصدار.
مرجع
5d5054f8a23586f9b500fece1cb613a9dffc787b
حداثة الصيانة
١٩/٩/٢٠٢٦
الاستخدام
2 تنزيلات · 0 مشاهدات
بنية الملفات
📄 SKILL.md
مراجعة الشيفرة عبر خمسة محاور للجودة
قد تُخفي تغييرات الشيفرة مشكلات تتعلق بالصحة والأمان والبنية وسهولة القراءة والأداء. تطبق هذه المهارة عملية مراجعة منظمة وتنتج ملاحظات عملية مرتبة حسب الأولوية.
Clarify User Intent Before You Build
Underspecified requests cause teams to build the wrong outcome and discover misalignment late. This skill runs a focused, one-question interview that turns ambiguity into confirmed intent.
Plan Work Into Verifiable Tasks
Large or vague software work can hide dependencies, missing acceptance criteria, and verification gaps. This skill converts a specification into ordered task slices with checkpoints, scope guidance, and clear completion conditions.
Build Accessible, Production-Ready Frontends
Frontend work can become inconsistent, inaccessible, or difficult to maintain. This skill guides component architecture, responsive layouts, state handling, and polished user experiences.
Debug Errors with a Root-Cause Workflow
Debugging failures by guesswork wastes time and can hide the real cause. This skill provides a repeatable process for reproducing, isolating, fixing, and verifying problems.
Structure Better Context for Coding Agents
Coding agents lose accuracy when context is incomplete, stale, or excessive. This skill provides practical structures for focused sessions, durable rules, and reliable handoffs.
إنشاء توثيق Markdown احترافي
بواسطة AutumnsGrove
تحتاج الفرق إلى توثيق واضح للمشاريع يحافظ على الاتساق عبر ملفات README وسجلات التغييرات وأدلة المساهمة. يوفر Markdown Pro قوالب وبنية وسير عمل مساعد لإنشاء وثائق تقنية مصقولة.
Write Clear Go Documentation
بواسطة samber
Go projects often have incomplete comments, examples, and contributor guidance that slow adoption and maintenance. This skill provides structured guidance for writing, reviewing, and organizing documentation that matches Go conventions.
إنشاء وثائق إصدار GitHub ثنائية اللغة
بواسطة ZhanlinCui
إن إنشاء وثائق إصدار احترافية يتطلب وقتًا ويتسم بالاتساق عبر اللغات. تقوم هذه المهارة بأتمتة إنشاء ملفات README ثنائية اللغة من البيانات الوصفية الموجودة في مستودعك.
بنية مستودع الوثائق
بواسطة AstraBit-CPT
غالبًا ما تصبح وثائق المستودعات قديمة عندما تتغير التبعيات وواجهات API وخطوات الإعداد. تحلل هذه المهارة البنية والتكاملات، ثم تساعد في إنشاء وثائق README وAPI والبنية والمساهمة والتكامل.
إنشاء قوالب مستودعات رائعة
بواسطة zjsxply
يتطلب إنشاء قائمة رائعة مصقولة بنية دقيقة، وقواعد مساهمة، وخطوات تحقق. تنشئ هذه المهارة قالب مستودع مركزا انطلاقا من موضوع وموارد أولية.
إنشاء توثيق تقني واضح
بواسطة shubhamsaboo
غالبًا ما تواجه الفرق صعوبة في تحويل التفاصيل التقنية إلى توثيق واضح. تنظّم هذه المهارة ملفات README ومراجع API والدروس التعليمية والأدلة لـ Claude وCodex وClaude Code.