docs-writer

Name: docs-writer
Author: incubrain

78stars8forks

How to install docs-writer?

incubrain/foundry/docs-writer

$npx -y skills add incubrain/foundry --skill docs-writer

Installs into the current project.

Summary

Creates and edits Dark Sky Conservation policy documentation for Maharashtra government officials and academics. Handles audience-appropriate tone, section-specific content rules (Research/Policy/Pilots), and orchestrates technical validation passes. Use when working on docs/cont

Files · 1

View on GitHub

SKILL.md

1	## Target Audience
2
3	Documentation serves two primary audiences:
4
5	### 1. Government Officials
6	- Level: State department heads and senior bureaucrats
7	- Departments: Environment, Tourism, Energy, Agriculture, Forest, Public Health
8	- Needs: Evidence-based justification for policy action, clear recommendations, implementation guidance
9	- Reading context: Decision-making on policy adoption and resource allocation
10
11	### 2. Academic Researchers
12	- Level: Policy analysts, technical advisors, research institutions
13	- Institutions: IIT, IISER, TIFR, environmental organizations
14	- Needs: Rigorous citations, methodological clarity, data transparency
15	- Reading context: Evidence evaluation, peer review, technical consultation
16
17	## Writing Principles
18
19	### Tone and Voice
20
21	Authoritative but Accessible
22	- Third-person objective voice (API reference style)
23	- Evidence-based assertions (every claim cited)
24	- Technical terms explained on first use
25	- Confident recommendations without overstatement
26
27	Guiding, Not Assuming
28	- Explain reasoning behind recommendations
29	- Acknowledge iteration and refinement process
30	- Present options with trade-offs when applicable
31	- Respect reader intelligence while providing context
32
33	### Writing Quality Standards
34
35	Grammar and Clarity
36	- Grammatically correct and properly punctuated
37	- Complete sentences (not fragments)
38	- Clear and unambiguous phrasing
39	- Brevity valued, but never at cost of clarity
40
41	Active Voice (85%+)
42	- Subject performs action: "The study documents..." (not "is documented by")
43	- Direct and clear: "Maharashtra can implement..." (not "can be implemented")
44	- Passive acceptable when: actor unknown, object more important, or describing system behavior
45
46	Present Tense (90%)
47	- Current state: "Research demonstrates..."
48	- Recommendations: "Policy should require..."
49	- Future only for consequences: "This will reduce emissions by..."
50
51	### Modal Verbs (Precision in Recommendations)
52
53	Use modal verbs to convey appropriate certainty and obligation:
54
55	\| Verb \| Meaning \| Usage \| Example \|
56	\|------\|---------\|-------\|---------\|
57	\| `can` \| Optional (40%) \| Capabilities, options \| "Municipalities can implement lighting curfews." \|
58	\| `should` \| Recommended (30%) \| Best practices \| "Policies should prioritize ecological zones." \|
59	\| `may` \| Possibility (20%) \| Conditional outcomes \| "This may reduce bird collisions." \|
60	\| `must` \| Required (10%) \| Mandatory actions \| "Protected areas must limit upward light." \|
61
62	Avoid weak modals: `might`, `could`, `would` (use sparingly, only for hypotheticals)
63
64	### Content Maturity Stages
65
66	\| Section \| Current Stage \| End Goal \|
67	\|---------\|--------------\|----------\|
68	\| Research \| Evidence compilation \| Scientific foundation for policy \|
69	\| Policy \| Recommendations → Refined proposals \| Foundation for official policy \|
70	\| Pilots \| Guidelines → Standards \| Adopted implementation protocols \|
71
72	Language reflects stage:
73	- Research: "Studies document...", "Evidence indicates..."
74	- Policy (early): "Recommendations include...", "Framework proposes..."
75	- Policy (refined): "Notification shall require...", "Standards mandate..."
76	- Pilots (early): "Guidelines suggest...", "Methodology encompasses..."
77	- Pilots (refined): "Standards require...", "Protocols specify..."
78
79	### Sentence Patterns
80
81	Subject-First Declarative (60%)
82	```
83	Light pollution disrupts nocturnal ecosystems.
84	The UNFCCC recognizes lighting efficiency as a climate strategy.
85	Maharashtra's protected areas face light intrusion.
86	```
87
88	Imperative Instructions (25%)
89	```
90	Review the ecological impact evidence in Section 2.1.
91	Consider the economic burden documented by RAND Europe.
92	Implement shielding requirements for coastal lighting.
93	```
94
95	Contextual Openers (15%)
96	```
97	When protecting migratory corridors, restrict lighting to essential safety needs.
98	During pilot implementation, monitor sky brightness monthly.
99	For agricultural zones, prioritize pollinator-friendly spectrum.
100	```
101
102	### Paragraph Structure
103
104	Length: 2-4 sentences maximum
105	Structure: Topic sentence first, then supporting details
106
107	```
108	Route middleware runs before navigation.
109	Use it to check authentication or redirect users.
110	Define middleware in the middleware directory.
111	```
112
113	Opening Sentences
114	- Define what it is, its purpose, key benefits
115	- Avoid: "This section describes...", "In this document...", "Let's explore..."
116	- Instead: State directly what the content covers
117
118	## Documentation Structure
119
120	### Directory Navigation Files
121
122	Each docs directory MUST include a `navigation.yml` file with this structure:
123
124	```yaml
125	title: 'Document Group Heading'
126	icon: i-lucide-icon-name
127	```
128
129	**

People who liked this also viewed

6 picks

Type

docs-writer

78stars8forks

View on GitHub

How to install docs-writer?

incubrain/foundry/docs-writer

$npx -y skills add incubrain/foundry --skill docs-writer

Installs into the current project.

Summary

Files · 1

View on GitHub

SKILL.md

1	## Target Audience
2
3	Documentation serves two primary audiences:
4
5	### 1. Government Officials
6	- Level: State department heads and senior bureaucrats
7	- Departments: Environment, Tourism, Energy, Agriculture, Forest, Public Health
8	- Needs: Evidence-based justification for policy action, clear recommendations, implementation guidance
9	- Reading context: Decision-making on policy adoption and resource allocation
10
11	### 2. Academic Researchers
12	- Level: Policy analysts, technical advisors, research institutions
13	- Institutions: IIT, IISER, TIFR, environmental organizations
14	- Needs: Rigorous citations, methodological clarity, data transparency
15	- Reading context: Evidence evaluation, peer review, technical consultation
16
17	## Writing Principles
18
19	### Tone and Voice
20
21	Authoritative but Accessible
22	- Third-person objective voice (API reference style)
23	- Evidence-based assertions (every claim cited)
24	- Technical terms explained on first use
25	- Confident recommendations without overstatement
26
27	Guiding, Not Assuming
28	- Explain reasoning behind recommendations
29	- Acknowledge iteration and refinement process
30	- Present options with trade-offs when applicable
31	- Respect reader intelligence while providing context
32
33	### Writing Quality Standards
34
35	Grammar and Clarity
36	- Grammatically correct and properly punctuated
37	- Complete sentences (not fragments)
38	- Clear and unambiguous phrasing
39	- Brevity valued, but never at cost of clarity
40
41	Active Voice (85%+)
42	- Subject performs action: "The study documents..." (not "is documented by")
43	- Direct and clear: "Maharashtra can implement..." (not "can be implemented")
44	- Passive acceptable when: actor unknown, object more important, or describing system behavior
45
46	Present Tense (90%)
47	- Current state: "Research demonstrates..."
48	- Recommendations: "Policy should require..."
49	- Future only for consequences: "This will reduce emissions by..."
50
51	### Modal Verbs (Precision in Recommendations)
52
53	Use modal verbs to convey appropriate certainty and obligation:
54
55	\| Verb \| Meaning \| Usage \| Example \|
56	\|------\|---------\|-------\|---------\|
57	\| `can` \| Optional (40%) \| Capabilities, options \| "Municipalities can implement lighting curfews." \|
58	\| `should` \| Recommended (30%) \| Best practices \| "Policies should prioritize ecological zones." \|
59	\| `may` \| Possibility (20%) \| Conditional outcomes \| "This may reduce bird collisions." \|
60	\| `must` \| Required (10%) \| Mandatory actions \| "Protected areas must limit upward light." \|
61
62	Avoid weak modals: `might`, `could`, `would` (use sparingly, only for hypotheticals)
63
64	### Content Maturity Stages
65
66	\| Section \| Current Stage \| End Goal \|
67	\|---------\|--------------\|----------\|
68	\| Research \| Evidence compilation \| Scientific foundation for policy \|
69	\| Policy \| Recommendations → Refined proposals \| Foundation for official policy \|
70	\| Pilots \| Guidelines → Standards \| Adopted implementation protocols \|
71
72	Language reflects stage:
73	- Research: "Studies document...", "Evidence indicates..."
74	- Policy (early): "Recommendations include...", "Framework proposes..."
75	- Policy (refined): "Notification shall require...", "Standards mandate..."
76	- Pilots (early): "Guidelines suggest...", "Methodology encompasses..."
77	- Pilots (refined): "Standards require...", "Protocols specify..."
78
79	### Sentence Patterns
80
81	Subject-First Declarative (60%)
82	```
83	Light pollution disrupts nocturnal ecosystems.
84	The UNFCCC recognizes lighting efficiency as a climate strategy.
85	Maharashtra's protected areas face light intrusion.
86	```
87
88	Imperative Instructions (25%)
89	```
90	Review the ecological impact evidence in Section 2.1.
91	Consider the economic burden documented by RAND Europe.
92	Implement shielding requirements for coastal lighting.
93	```
94
95	Contextual Openers (15%)
96	```
97	When protecting migratory corridors, restrict lighting to essential safety needs.
98	During pilot implementation, monitor sky brightness monthly.
99	For agricultural zones, prioritize pollinator-friendly spectrum.
100	```
101
102	### Paragraph Structure
103
104	Length: 2-4 sentences maximum
105	Structure: Topic sentence first, then supporting details
106
107	```
108	Route middleware runs before navigation.
109	Use it to check authentication or redirect users.
110	Define middleware in the middleware directory.
111	```
112
113	Opening Sentences
114	- Define what it is, its purpose, key benefits
115	- Avoid: "This section describes...", "In this document...", "Let's explore..."
116	- Instead: State directly what the content covers
117
118	## Documentation Structure
119
120	### Directory Navigation Files
121
122	Each docs directory MUST include a `navigation.yml` file with this structure:
123
124	```yaml
125	title: 'Document Group Heading'
126	icon: i-lucide-icon-name
127	```
128
129	**

People who liked this also viewed

6 picks

Type