来自代码的文档

文档 社区

技能解读

当前原文的自动摘译,尚未人工审校。

概述

将代码的功能翻译成人们可以实际使用的文档。

核心工作流程

首先确定受众:开发人员、操作员、客户、审阅者或团队成员。阅读代码、脚本、配置和测试,以提取准确的设置步骤、行为、约束和术语。围绕真实的用户需求(例如设置、体系结构、使用、故障排除或更改影响)组织文档。仅当示例和命令受存储库或提供的工件支持时才添加示例和命令。

交付

生成具体、可运行且易于扫描的文档。包括注意事项、先决条件和重要的常见故障点。当家庭已经存在时,更新现有文档而不是创建重复文档。

护栏

不要发明命令、文件路径或保证。保持架构解释的高信号性而不是百科全书式。更喜欢存储库既定的基调和文档结构。

流狐档案 运行与权限由流狐静态检查推断,不代表作者声明或实际测试结果。
领域
文档
作者声明的智能体
未找到明确声明;不据此推断已兼容或已测试
静态检查
88 / 100 · 启发式扫描,不代表运行安全
运行环境证据
未执行;当前没有隔离运行测试证据
作者 / 版本 / 许可证
@00PrabalK00 · 未声明许可证
上下文用量评级
低消耗
接入复杂程度
即装即用
是否需要外部接口密钥
不需要
兼容的系统
未声明(默认跨平台)
运行环境要求
未检出明确要求
检测到的文件与系统行为
  • 只读
  • 允许写入 / 修改
网络行为
仅限本地
安装命令数
无(仅作为资料)

需要注意: 未声明工具权限范围;实际权限由运行环境决定。

作者说明文件(原文) SKILL.md

# Docs From Code

## Overview

Translate what the code does into documentation people can actually use.

## Core Workflow

1. Identify the audience first: developer, operator, customer, reviewer, or teammate.
2. Read the code, scripts, config, and tests to extract accurate setup steps, behaviors, constraints, and terminology.
3. Organize the document around real user needs such as setup, architecture, usage, troubleshooting, or change impact.
4. Add examples and commands only when they are supported by the repo or provided artifacts.
5. Tighten for clarity and remove implementation noise that does not help the audience.

## Deliver

- Produce docs that are specific, runnable, and easy to scan.
- Include caveats, prerequisites, and common failure points when they matter.
- Update existing docs instead of creating duplicates when a home already exists.

## Guardrails

- Do not invent commands, file paths, or guarantees.
- Keep architecture explanations high-signal rather than encyclopedic.
- Prefer the repository's established tone and documentation structure.

讨论

基于 GitHub Discussions。登录 GitHub 即可参与讨论、点赞、订阅更新。