Skip to main content

technical-writing

Guide for writing effective technical documentation, specs, and markdown files. Use when creating or editing specs, documentation, READMEs, AGENTS.md files, or any markdown content in the codebase.

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

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

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

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

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

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

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

عرض SKILL.md

SKILL.md
تعليمات المصدر · معاينة للقراءة فقط
name
technical-writing
description
Guide for writing effective technical documentation, specs, and markdown files. Use when creating or editing specs, documentation, READMEs, AGENTS.md files, or any markdown content in the codebase.
# Technical Writing ## Audience Assume readers are at least as smart as you, so do not over-explain. State information once and move on. ## Style Write concise, complete sentences using active voice and present tense. Each paragraph or bullet should express a single idea. ## Formatting - Do not use emojis. - Do not use bold or italics. - Use headings, lists, and code blocks only when they add clarity. - Use fenced code blocks with language identifiers. ## Paths Always use relative file paths: `docs/testing.md`, not `/Users/name/project/docs/testing.md`. ## Do Not Repeat Link to existing resources instead of duplicating content. Reference other docs, web pages, or files rather than restating their information.
عرض على GitHub