Agent skill

Markdown Doc Writer

by yennanliu in yennanliu/CS_basics

Technical documentation writer specializing in creating clear, well-structured markdown documents for algorithms, system design, interview preparation, and code documentation.

No licenceAuto-check passedDevelopment

Install Markdown Doc Writer

skills CLI
$ npx skills add yennanliu/CS_basics --skill markdown-doc-writer -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install yennanliu/CS_basics markdown-doc-writer --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/yennanliu/CS_basics.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/markdown-doc-writer .claude/skills/markdown-doc-writer && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
markdown-doc-writer
GitHub stars
141
Token cost
~2.3k tokens
SKILL.md length
359 words
Files
1
Skills in repo
16
Repo updated
First seen
Licence
None found

At a glance

Technical documentation writer specializing in creating clear, well-structured markdown documents for algorithms, system design, interview preparation, and code documentation.

  • Works in 5 steps: Structure Guidelines → Algorithm Documentation Format → Complexity Analysis Documentation → …
  • Writing README files
  • SKILL.md covers When to use this Skill, Documentation Standards, Alternative Approaches and Key Takeaways, plus 10 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Markdown Doc Writer is an agent skill from yennanliu/CS_basics. Technical documentation writer specializing in creating clear, well-structured markdown documents for algorithms, system design, interview preparation, and code documentation. Use when writing README files, algorithm explanations, system design docs, or technical guides.

Its SKILL.md is about 2.3k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Technical documentation, Interview preparation and Markdown. The repository describes itself as: My CS learning : algorithm, data structure, and system design | SE.

When your agent uses it

  • Writing README files
  • Algorithm explanations
  • System design docs
  • Technical guides

Example prompts

  • “/markdown-doc-writer”

Requirements

  • Python 3
  • Pre-approved tools (allowed-tools): Read, Glob, Grep, Edit, Write

Workflow steps

5 steps, taken from the step headings in SKILL.md.

  1. Structure Guidelines
  2. Algorithm Documentation Format
  3. Complexity Analysis Documentation
  4. Writing Style Guidelines
  5. Interview Preparation Docs

What it can do on your machine

Read from SKILL.md and the folder at commit cb6b21b. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves these tools, so the agent can use them without asking each time:

    • Read
    • Glob
    • Grep
    • Edit
    • Write

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are markdown, python and code).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Markdown Doc Writer loads about 2.3k tokens when it runs. Until then it costs about 73 tokens; SKILL.md has 359 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~73
When it runs · the whole SKILL.md, loaded when a task matches
~2.3k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

Without a licence we can't republish the file, so here is its outline and opening line. It has 359 words (~2,329 tokens).

name
markdown-doc-writer
allowed-tools
Read, Glob, Grep, Edit, Write

Read the full SKILL.md on GitHub

Files

Just SKILL.md in .claude/skills/markdown-doc-writer of yennanliu/CS_basics.

Open the folder on GitHubat commit cb6b21b

Compare with similar skills

Markdown Doc Writer next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Markdown Doc Writer compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Markdown Doc Writer this skillyennanliu/CS_basics141—~2.3kAutomated safety check: PassNone
WooCommerce Markdown Guidelineswoocommerce/woocommerce11k1 repos~1.7kAutomated safety check: PassCustom licence
Update .NET Supported OS Matrixdotnet/core22k—~4.1kAutomated safety check: PassMIT
README Badges and Headersjal-co/shieldcn919—~4.3kAutomated safety check: PassMIT
Docs Conventionsflet-dev/flet17k—~1.6kAutomated safety check: PassApache-2.0
QML Reference Documentationx-tools-author/x-tools1.1k1 repos~2.5kAutomated safety check: PassBSD-3-Clause

Similar skills

  • WooCommerce Markdown Guidelines

    woocommerce/woocommerce

    Rules for writing and editing markdown in the WooCommerce repository, with the project's markdownlint settings for headings, lists and code blocks.

    11k GitHub starsUsed in 1 repo~1.7k tokens
    DevelopmentAuto-check passed
  • Official

    Audits and updates the supported-os.json files for .NET releases, checking them against upstream lifecycle data and regenerating the markdown with the release-notes tool.

    22k GitHub stars~4.1k tokensUpdated yesterday
    DevelopmentAuto-check passed
  • Adds shadcn/ui-styled README badges, badge groups, download charts, header banners and sponsor or contributor grids using the shieldcn service.

    919 GitHub stars~4.3k tokensUpdated today
    DevelopmentAuto-check passed
  • Docs Conventions

    flet-dev/flet

    A skill your agent uses when writing or reviewing Flet documentation, including Python docstrings (Google style, reST roles, admonitions), Markdown docs (cross-references, images, code examples)…

    17k GitHub stars~1.6k tokensUpdated yesterday
    DevelopmentAuto-check passed
  • QML Reference Documentation

    x-tools-author/x-tools

    Generates standalone Markdown reference docs for QML components and Qt Quick applications from .qml source and related C++ and build files, one file per component.

    1.1k GitHub starsUsed in 1 repo~2.5k tokens
    DevelopmentAuto-check passed
  • Article Exporter

    actionbook/actionbook

    Export any web article to a local Obsidian-ready Markdown directory.

    1.6k GitHub stars~3.1k tokensUpdated 1 mo ago
    DevelopmentAuto-check passed

More from yennanliu/CS_basics

All 16 skills in this repo
  • Lc Coach

    yennanliu/CS_basics

    FAANG coding-interview coach. An agent skill from yennanliu/CS_basics.

    141 GitHub stars~5k tokensUpdated today
    Auto-check: notes
  • Code Refactor Master

    yennanliu/CS_basics

    Code refactoring expert for improving code quality, readability, maintainability, and performance.

    141 GitHub stars~3.3k tokensUpdated today
    Auto-check passed
  • L3 Core

    yennanliu/CS_basics

    Report where the L3 core set stands and pick the next problems to drill from it.

    141 GitHub stars~2.2k tokensUpdated today
    Auto-check: notes
  • Lc Again

    yennanliu/CS_basics

    Move a problem's README status cell after a re-solve — promote AGAIN to OK when it was genuinely re-derived unaided, add a review pass when it was not, or demote OK back to AGAIN when a solid…

    141 GitHub stars~2.4k tokensUpdated today
    Auto-check: notes
  • Lc Algo Demo

    yennanliu/CS_basics

    Add or edit an algorithm visualizer under algodemo/ against the shared contract the other 36 pages already obey — colours read from the VIZ palette and never hardcoded, no re-implementation of the…

    141 GitHub stars~2.4k tokensUpdated today
    Auto-check: notes
  • Lc Cheatsheet

    yennanliu/CS_basics

    File a LeetCode problem into the cheatsheets under doc/cheatsheet/ the way the existing sections are written — find the sheet whose Scope line owns the topic, file it under the pattern it belongs to…

    141 GitHub stars~3.5k tokensUpdated today
    Auto-check: notes

Categories

Questions about Markdown Doc Writer

What does Markdown Doc Writer do?

Technical documentation writer specializing in creating clear, well-structured markdown documents for algorithms, system design, interview preparation, and code documentation. Markdown Doc Writer is an agent skill from yennanliu/CS_basics. Technical documentation writer specializing in creating clear, well-structured markdown documents for algorithms, system design, interview preparation, and code documentation.

When should I use Markdown Doc Writer?

Markdown Doc Writer fits situations like: writing README files; algorithm explanations; system design docs; technical guides.

How do I install Markdown Doc Writer in Claude Code?

Run `npx skills add yennanliu/CS_basics --skill markdown-doc-writer -a claude-code`. Or copy the skill folder (.claude/skills/markdown-doc-writer in yennanliu/CS_basics) into .claude/skills/markdown-doc-writer in your project. Claude Code loads it when a task matches its description.

How do I install Markdown Doc Writer in Codex?

Run `npx skills add yennanliu/CS_basics --skill markdown-doc-writer -a codex`. Or copy the skill folder (.claude/skills/markdown-doc-writer in yennanliu/CS_basics) into .agents/skills/markdown-doc-writer in your project. Codex loads it when a task matches its description.

Can I use Markdown Doc Writer in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add yennanliu/CS_basics --skill markdown-doc-writer -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/markdown-doc-writer, .gemini/skills/markdown-doc-writer, .github/skills/markdown-doc-writer and .opencode/skills/markdown-doc-writer in your project.

What does Markdown Doc Writer need to run?

SKILL.md names no scripts, command-line tools or credentials: Markdown Doc Writer is instructions for the agent only. Our summary lists: Python 3. Its frontmatter pre-approves these tools: Read, Glob, Grep, Edit, Write.

Does Markdown Doc Writer access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Markdown Doc Writer safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Markdown Doc Writer use?

No licence was found for Markdown Doc Writer or its repository. Without one, default copyright applies: ask the author before reusing or redistributing it.

How many tokens does Markdown Doc Writer use?

About 2.3k tokens (SKILL.md is roughly 9.3k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Markdown Doc Writer?

Skills that share tags, products or a category with Markdown Doc Writer: WooCommerce Markdown Guidelines (woocommerce/woocommerce, 11k stars), Update .NET Supported OS Matrix (dotnet/core, 22k stars), README Badges and Headers (jal-co/shieldcn, 919 stars) and Docs Conventions (flet-dev/flet, 17k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Markdown Doc Writer?

yennanliu (a GitHub user) maintains it in yennanliu/CS_basics, which has 141 GitHub stars. The repository holds 16 skills in this directory. The repository was last updated on October 10, 2026.

Source: yennanliu/CS_basics on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.