documentation-writer
Create Accurate Logseq Project Documentation
Maintaining accurate documentation across modules, guides, and scripts takes careful source analysis. This skill turns project files into structured, user-focused documentation.
Stop for confirmation before installing.
Review the plan and obtain explicit user consent before changing files.
Install with my Agent
Copy this request to your Agent. It includes the canonical Skill page and manifest.
Review the Skillstore skill "documentation-writer" from https://skillstore.io/skills/c0ntr0lledcha0s-documentation-writer.md and its manifest at https://skillstore.io/api/skills/c0ntr0lledcha0s-documentation-writer/manifest. Verify the artifact. Stop and obtain explicit user consent before installing or changing files.Your Agent should still show its plan and request any confirmation required by the security policy.
Agent-readable resources
Use these links when an AI agent, crawler, or script needs clean context instead of reading the full page.
Test it
Using "documentation-writer". Document the person module from its class and property definitions.
Expected outcome:
- Person Module
- Overview explaining the module purpose and scope.
- Class and property sections grounded in source definitions.
- Two practical usage examples and relevant Schema.org references.
Using "documentation-writer". Update the installation guide for the current Babashka setup.
Expected outcome:
- Installation Guide
- Current prerequisites and supported setup methods.
- Ordered installation and verification steps.
- Troubleshooting notes and related next steps.
Using "documentation-writer". Create a reference for the build script.
Expected outcome:
- Build Script Reference
- Purpose, location, and dependencies.
- Functions, parameters, options, outputs, and exit codes.
- Approved usage examples with expected results.
Security Audit
High RiskAll 50 static findings are false positives caused by Markdown syntax, prose tokens, a documentation URL, and a relative link. A separate high-severity finding remains because the skill directs agents to run all commands without approval, sandboxing, or source-trust checks.
Confirmed security concerns (1)
Risk Factors
⚙️ External commands (41)
🌐 Network access (2)
📁 Filesystem access (1)
Share & cite this report
Share the versioned assessment report, neutral badge, embed card, and citations. Skillstore reports evidence without deciding whether this Skill is safe.
Copy report link
https://skillstore.io/skills/c0ntr0lledcha0s-documentation-writer/audits/9?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown badge
[](https://skillstore.io/skills/c0ntr0lledcha0s-documentation-writer?utm_source=security_passport_badge)HTML badge
<a href="https://skillstore.io/skills/c0ntr0lledcha0s-documentation-writer?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/c0ntr0lledcha0s-documentation-writer/security.svg" alt="Skillstore security assessment" loading="lazy"></a>Embed card
<iframe src="https://skillstore.io/embed/skills/c0ntr0lledcha0s-documentation-writer.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>Academic citations (APA · BibTeX · CFF)
APA citation
C0ntr0lledCha0s. (2026). documentation-writer security audit report (audit version 9) [Author version unspecified]. Skillstore. https://skillstore.io/skills/c0ntr0lledcha0s-documentation-writer/audits/9BibTeX citation
@techreport{c0ntr0lledcha0s-c0ntr0lledcha0s-documentation-writer-2026,
author = {C0ntr0lledCha0s},
title = {documentation-writer security audit report (audit version 9)},
institution = {Skillstore},
year = {2026},
number = {9},
url = {https://skillstore.io/skills/c0ntr0lledcha0s-documentation-writer/audits/9},
note = {Author version unspecified}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "documentation-writer security audit report (audit version 9)"
version: "unspecified"
type: report
authors:
- name: "C0ntr0lledCha0s"
date-released: "2026-07-23"
url: "https://skillstore.io/skills/c0ntr0lledcha0s-documentation-writer/audits/9"
identifiers:
- type: other
value: "skillstore:c0ntr0lledcha0s-documentation-writer:audit:9"
description: "Skillstore immutable audit report identifier"
Compare variants
2 installable variantsEach author remains a separate installable skill. The recommended variant is ranked by Skillstore evidence.
Why this variant is first
github-documentation-writer
2026-08-21
c0ntr0lledcha0s-documentation-writer
2026-08-21
Skillstore Score
Why this score Evidence Confidence: MediumWhat You Can Build
Maintain Module Documentation
Generate or update module READMEs from class and property definitions while preserving Logseq Template Graph structure.
Guide Project Users
Turn feature behavior into task-focused guides with prerequisites, steps, examples, troubleshooting, and next actions.
Reference Scripts and APIs
Create technical references for scripts, commands, functions, parameters, options, outputs, and exit codes.
Try These Prompts
Read [module files] and draft a README for [module]. Include an overview, classes, properties, two usage examples, and Schema.org mappings.
Review [existing guide] against [current setup files]. Update prerequisites and steps, preserve established terminology, and list facts that require confirmation.
Analyze [script path] and create a technical reference. Document functions, parameters, options, outputs, exit codes, dependencies, and approved usage examples.
Compare [documentation paths] with [source paths]. Identify missing, outdated, or inconsistent sections, then propose prioritized edits with source evidence and validation needs.
Best Practices
- Provide the target audience, source paths, and desired document location before generation.
- Review every factual statement against current project files and identify assumptions that need confirmation.
- Approve each validation command and run it only in a controlled environment.
Avoid
- Do not request documentation without sharing relevant source files or repository context.
- Do not publish placeholder examples, untested commands, or unsupported behavior claims.
- Do not run repository commands automatically or expose secrets while validating examples.
Frequently Asked Questions
What documentation can this skill create?
Is this skill limited to Logseq projects?
Does the skill modify project files?
Will it test commands automatically?
What happens when source information is incomplete?
Can it verify external links and mappings?
Developer Details
Author
C0ntr0lledCha0sLicense
MIT
Skillstore revision
r2
Version notice
The author did not declare a version.
Ref
a39a91716eadede5f4cdefd78178fed4e837a128
Maintenance freshness
7/24/2026
Usage
9 downloads · 166 views
File structure
📄 SKILL.md