documentation-templates

Name: documentation-templates
Author: One-Man-Company

77stars16forks

How to install documentation-templates?

one-man-company/skills-contextmanager/documentation-templates

$npx -y skills add One-Man-Company/Skills-ContextManager --skill documentation-templates

Installs into the current project.

Summary

Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.

Files · 1

View on GitHub

SKILL.md

1	# Documentation Templates
2
3	> Templates and structure guidelines for common documentation types.
4
5	---
6
7	## 1. README Structure
8
9	### Essential Sections (Priority Order)
10
11	\| Section \| Purpose \|
12	\|---------\|---------\|
13	\| Title + One-liner \| What is this? \|
14	\| Quick Start \| Running in <5 min \|
15	\| Features \| What can I do? \|
16	\| Configuration \| How to customize \|
17	\| API Reference \| Link to detailed docs \|
18	\| Contributing \| How to help \|
19	\| License \| Legal \|
20
21	### README Template
22
23	```markdown
24	# Project Name
25
26	Brief one-line description.
27
28	## Quick Start
29
30	[Minimum steps to run]
31
32	## Features
33
34	- Feature 1
35	- Feature 2
36
37	## Configuration
38
39	\| Variable \| Description \| Default \|
40	\|----------\|-------------\|---------\|
41	\| PORT \| Server port \| 3000 \|
42
43	## Documentation
44
45	- [API Reference](./docs/api.md)
46	- [Architecture](./docs/architecture.md)
47
48	## License
49
50	MIT
51	```
52
53	---
54
55	## 2. API Documentation Structure
56
57	### Per-Endpoint Template
58
59	```markdown
60	## GET /users/:id
61
62	Get a user by ID.
63
64	Parameters:
65	\| Name \| Type \| Required \| Description \|
66	\|------\|------\|----------\|-------------\|
67	\| id \| string \| Yes \| User ID \|
68
69	Response:
70	- 200: User object
71	- 404: User not found
72
73	Example:
74	[Request and response example]
75	```
76
77	---
78
79	## 3. Code Comment Guidelines
80
81	### JSDoc/TSDoc Template
82
83	```typescript
84	/**
85	* Brief description of what the function does.
86	*
87	* @param paramName - Description of parameter
88	* @returns Description of return value
89	* @throws ErrorType - When this error occurs
90	*
91	* @example
92	* const result = functionName(input);
93	*/
94	```
95
96	### When to Comment
97
98	\| ✅ Comment \| ❌ Don't Comment \|
99	\|-----------\|-----------------\|
100	\| Why (business logic) \| What (obvious) \|
101	\| Complex algorithms \| Every line \|
102	\| Non-obvious behavior \| Self-explanatory code \|
103	\| API contracts \| Implementation details \|
104
105	---
106
107	## 4. Changelog Template (Keep a Changelog)
108
109	```markdown
110	# Changelog
111
112	## [Unreleased]
113	### Added
114	- New feature
115
116	## [1.0.0] - 2025-01-01
117	### Added
118	- Initial release
119	### Changed
120	- Updated dependency
121	### Fixed
122	- Bug fix
123	```
124
125	---
126
127	## 5. Architecture Decision Record (ADR)
128
129	```markdown
130	# ADR-001: [Title]
131
132	## Status
133	Accepted / Deprecated / Superseded
134
135	## Context
136	Why are we making this decision?
137
138	## Decision
139	What did we decide?
140
141	## Consequences
142	What are the trade-offs?
143	```
144
145	---
146
147	## 6. AI-Friendly Documentation (2025)
148
149	### llms.txt Template
150
151	For AI crawlers and agents:
152
153	```markdown
154	# Project Name
155	> One-line objective.
156
157	## Core Files
158	- [src/index.ts]: Main entry
159	- [src/api/]: API routes
160	- [docs/]: Documentation
161
162	## Key Concepts
163	- Concept 1: Brief explanation
164	- Concept 2: Brief explanation
165	```
166
167	### MCP-Ready Documentation
168
169	For RAG indexing:
170	- Clear H1-H3 hierarchy
171	- JSON/YAML examples for data structures
172	- Mermaid diagrams for flows
173	- Self-contained sections
174
175	---
176
177	## 7. Structure Principles
178
179	\| Principle \| Why \|
180	\|-----------\|-----\|
181	\| Scannable \| Headers, lists, tables \|
182	\| Examples first \| Show, don't just tell \|
183	\| Progressive detail \| Simple → Complex \|
184	\| Up to date \| Outdated = misleading \|
185
186	---
187
188	> Remember: Templates are starting points. Adapt to your project's needs.

People who liked this also viewed

6 picks

Type

grill-with-docsA relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.SkillsJul 2026537k182k
lark-minutes飞书妙记：搜索妙记、查看妙记基础信息、下载/上传音视频、读取或编辑妙记的产物内容、改标题、替换说话人/关键词、申请妙记查看/编辑权限。当给出minute_token、本地音视频文件，要查/改/转妙记产物，或用户明确要主动申请妙记权限时使用；本地音视频转纪要/逐字稿优先走本 skill，不要用 ffmpeg/whisper 本地转写。不负责：获取会议关联妙记，或仅按自然语言标题定位纪要SkillsJul 2026379k16k
lark-markdown飞书 Markdown：查看、创建、上传、编辑和比较 Markdown 文件。当用户需要创建或编辑 Markdown 文件、读取、修改、局部 patch 或比较差异时使用。不负责将 Markdown 导入为飞书在线文档，也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。SkillsJul 2026295k16k
docxUse this skill whenever the user wants to create, read, edit, or manipulate Word documents (.docx files) or Word templates (.dotx files). Triggers include: any mention of 'Word doc', 'word document', SkillsJul 2026157k163k
edit-articleSkills for Real Engineers. Straight from my .agents directory.SkillsJul 2026154k181k
lark-note飞书会议纪要（Note）直查：已知 note_id 时查询纪要详情、展示类型、关联文档 token，并读取 unified 原始逐字记录。当用户已持有 note_id，或从文档显式 vc-node-id 获得 note_id 时使用。不负责会议/日程/妙记定位、文档标题搜索或 Docx 正文读取。SkillsJul 2026154k16k

documentation-templates

77stars16forks

View on GitHub

How to install documentation-templates?

one-man-company/skills-contextmanager/documentation-templates

$npx -y skills add One-Man-Company/Skills-ContextManager --skill documentation-templates

Installs into the current project.

Summary

Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.

Files · 1

View on GitHub

SKILL.md

1	# Documentation Templates
2
3	> Templates and structure guidelines for common documentation types.
4
5	---
6
7	## 1. README Structure
8
9	### Essential Sections (Priority Order)
10
11	\| Section \| Purpose \|
12	\|---------\|---------\|
13	\| Title + One-liner \| What is this? \|
14	\| Quick Start \| Running in <5 min \|
15	\| Features \| What can I do? \|
16	\| Configuration \| How to customize \|
17	\| API Reference \| Link to detailed docs \|
18	\| Contributing \| How to help \|
19	\| License \| Legal \|
20
21	### README Template
22
23	```markdown
24	# Project Name
25
26	Brief one-line description.
27
28	## Quick Start
29
30	[Minimum steps to run]
31
32	## Features
33
34	- Feature 1
35	- Feature 2
36
37	## Configuration
38
39	\| Variable \| Description \| Default \|
40	\|----------\|-------------\|---------\|
41	\| PORT \| Server port \| 3000 \|
42
43	## Documentation
44
45	- [API Reference](./docs/api.md)
46	- [Architecture](./docs/architecture.md)
47
48	## License
49
50	MIT
51	```
52
53	---
54
55	## 2. API Documentation Structure
56
57	### Per-Endpoint Template
58
59	```markdown
60	## GET /users/:id
61
62	Get a user by ID.
63
64	Parameters:
65	\| Name \| Type \| Required \| Description \|
66	\|------\|------\|----------\|-------------\|
67	\| id \| string \| Yes \| User ID \|
68
69	Response:
70	- 200: User object
71	- 404: User not found
72
73	Example:
74	[Request and response example]
75	```
76
77	---
78
79	## 3. Code Comment Guidelines
80
81	### JSDoc/TSDoc Template
82
83	```typescript
84	/**
85	* Brief description of what the function does.
86	*
87	* @param paramName - Description of parameter
88	* @returns Description of return value
89	* @throws ErrorType - When this error occurs
90	*
91	* @example
92	* const result = functionName(input);
93	*/
94	```
95
96	### When to Comment
97
98	\| ✅ Comment \| ❌ Don't Comment \|
99	\|-----------\|-----------------\|
100	\| Why (business logic) \| What (obvious) \|
101	\| Complex algorithms \| Every line \|
102	\| Non-obvious behavior \| Self-explanatory code \|
103	\| API contracts \| Implementation details \|
104
105	---
106
107	## 4. Changelog Template (Keep a Changelog)
108
109	```markdown
110	# Changelog
111
112	## [Unreleased]
113	### Added
114	- New feature
115
116	## [1.0.0] - 2025-01-01
117	### Added
118	- Initial release
119	### Changed
120	- Updated dependency
121	### Fixed
122	- Bug fix
123	```
124
125	---
126
127	## 5. Architecture Decision Record (ADR)
128
129	```markdown
130	# ADR-001: [Title]
131
132	## Status
133	Accepted / Deprecated / Superseded
134
135	## Context
136	Why are we making this decision?
137
138	## Decision
139	What did we decide?
140
141	## Consequences
142	What are the trade-offs?
143	```
144
145	---
146
147	## 6. AI-Friendly Documentation (2025)
148
149	### llms.txt Template
150
151	For AI crawlers and agents:
152
153	```markdown
154	# Project Name
155	> One-line objective.
156
157	## Core Files
158	- [src/index.ts]: Main entry
159	- [src/api/]: API routes
160	- [docs/]: Documentation
161
162	## Key Concepts
163	- Concept 1: Brief explanation
164	- Concept 2: Brief explanation
165	```
166
167	### MCP-Ready Documentation
168
169	For RAG indexing:
170	- Clear H1-H3 hierarchy
171	- JSON/YAML examples for data structures
172	- Mermaid diagrams for flows
173	- Self-contained sections
174
175	---
176
177	## 7. Structure Principles
178
179	\| Principle \| Why \|
180	\|-----------\|-----\|
181	\| Scannable \| Headers, lists, tables \|
182	\| Examples first \| Show, don't just tell \|
183	\| Progressive detail \| Simple → Complex \|
184	\| Up to date \| Outdated = misleading \|
185
186	---
187
188	> Remember: Templates are starting points. Adapt to your project's needs.

People who liked this also viewed

6 picks

Type