The core philosophy of DeepSeek Harness (DSH) is “everything is a plugin”. When using large models to write technical documentation, common pain points include factual inaccuracies (hallucinations), inconsistent terminology, or an excessive “AI” tone. docs-mode is a DSH agent preset designed to solve these problems. It positions the Agent as a “Technical Documentation Specialist”, covers 11+ types of technical documents, and includes end-to-end tools from research to delivery.
What Is This¶
This is a self-contained DSH agent preset. Once installed, DSH no longer engages in general conversation in this mode; instead, it shifts to executing technical documentation-writing tasks. It has a built-in “research first, then write” working principle, requiring the model to verify actual project information and strictly prohibiting the fabrication of details.
Supported Document Types¶
This mode covers full-lifecycle documentation from development to delivery, and each type includes a built-in skeleton and style card:
| Category | Main Target |
|---|---|
| Development Overview Specification | System design, software copyright registration support |
| User Manual | End-user operation manual |
| Report/Summary Materials | Phase reports, project summaries |
| Interface/API Documentation | Interface contracts for external developers |
| Technical Review Draft | Solution/design review |
| Software Requirements Specification (SRS) | Product requirements |
| Project Plan | Milestones, responsibility assignment, risks |
| Test Report | Functional/performance/regression testing |
| Deployment and Operations Manual | Installation, configuration, upgrades, troubleshooting |
| Weekly Report/Meeting Minutes | Lightweight reporting and meeting records |
| Software Copyright Application Documentation | Software copyright user manual + development summary |
| English Technical Documentation | Generic English skeleton (README/Spec/API) |
Core Features¶
1. Template-Driven and Self-Learning¶
The mode has three built-in skills:
* doc-template-learning: Handles template-driven writing. When a user provides a template, the system first decomposes the skeleton, starts writing only after the outline is confirmed, and saves the skeleton/style card to the workspace. User-defined templates are automatically archived to ~/.dsh/template-library/<类别>/; when a category reaches 3 templates, it automatically extracts a “consensus skeleton” and a “consensus style card”.
* tech-doc-deai: Removes the “AI tone”. It rewrites high-risk phrasing based on the rule library, ensuring terminology is consistent, accurate, and concise, and strictly avoids colloquial expressions.
* doc-quality: Handles quality assurance. Includes quantitative checks (AI-tone index/numbering/quotes/boilerplate/terminology), cross-document consistency validation, renumbering, version synchronization checks, PDF export, and UI screenshot automation.
2. Template-Free Autonomous Writing¶
When no template is provided, the mode automatically selects a template based on three priority levels:
1. Workspace docs/style-cards/ (user-confirmed version)
2. ~/.dsh/template-library/ (self-learned consensus version)
3. This package assets/templates/ (built-in default version)
3. Flexible Delivery Formats¶
Supports Markdown, Word, and PDF formats. Word delivery uses assets/docx-tools/, PDF delivery uses the md_to_html + html_to_pdf pipeline, and software copyright source code documentation supports a 50-line/page layout.
Installation and Enablement¶
Method 1: Plugin Marketplace Installation (Recommended)¶
Search dsh-docs-mode in the plugin management interface to install it, or use the command directly:
dsh plugin add dsh-docs-mode
Method 2: Install from Local Source¶
You need to clone the repository locally and install it using an absolute path:
git clone https://github.com/zh851233/docs-mode
dsh plugin add /绝对路径/docs-mode
Enablement and Configuration Notes¶
- Restart DSH: After installation, you must restart DSH to load the new mode.
- Version Compatibility: Starting from DSH 0.2, it no longer reads the
$DSH_HOME/.agent-presets/<id>/directory. This plugin declares itself usingcordis.patch.yml, so manual file copying is not required. - Legacy Compatibility: The 1.x installer (
lib/index.js) is deprecated, is only for older DSH versions, and is no longer included in release packages.
Typical Usage¶
- Write from a template: Paste the template content into the conversation, or provide a file path, with an instruction such as “Write a user manual using this template”. The system first presents an outline for confirmation, then writes, and saves the confirmed template.
- Write without a template: Directly instruct “Write a technical review draft” or “Write a test report”. The system automatically matches a built-in template or a self-learned template.
- Remove AI tone: Before delivery, the system asks whether to remove the AI tone; after confirmation, it automatically applies the
tech-doc-deairules to revise the document. - Choose delivery format: Before delivery, answer “Export as Word” or “Export as PDF”; the system handles the conversion automatically.
Notes¶
- Upgrading from Older Versions: If you are upgrading from 1.x, be sure to clean up the old preset directory; otherwise, the mode will fail to load in DSH 0.2+:
# Windows
rmdir /s /q "%USERPROFILE%\.dsh\.agent-presets\docs"
# Linux/macOS
rm -rf ~/.dsh/.agent-presets/docs
- Permissions and Security: The plugin runs with the current DSH process permissions. Before installation, it is recommended to review the source code and license (MIT).
- Customization: If you need to adjust the strength of AI-tone removal or add phrasing rules, edit
skills/tech-doc-deai/tech-doc-deai.md; if you need to modify the persona, editpreset/agent.cordis.yml.
Summary¶
docs-mode transforms DSH into a practical technical documentation specialist through its template library, AI-tone removal toolchain, and quality assurance workflow. It is suitable for developers and engineers who need to batch-generate standardized documentation, software copyright materials, or technical review drafts.
- Project URL: https://github.com/zh851233/docs-mode
- Plugin catalog: https://www.skillhub.cn/plugins/zh851233/docs-mode