skills.rest
sieniven
sienivenCOMMUNITY
Explore all skills by this author →
𝕏@sienivenGitHub

lark-tech-doc-writer

Generate standardized Lark Wiki technical documents using a 4-section template.

Updated Oct 27, 2023
Search Tags:#templates#documentation#mermaid#plantuml#architecture-diagrams#uml
One-click install
npx skills add https://github.com/sieniven/dotfiles --skill lark-tech-doc-writer
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: lark-tech-doc-writer
Source: https://github.com/sieniven/dotfiles/tree/main/claude/skills/lark-tech-doc
Command: npx skills add https://github.com/sieniven/dotfiles --skill lark-tech-doc-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Write standardized, template-driven technical documents and architecture diagrams for Lark, ensuring consistency with team standards and publish-ready formatting.

Core Features & Use Cases

  • Enforces the 4-section technical document template (Glossary, Background, Problem, Solution) and supports architecture/diagram standards (Mermaid/PlantUML, UML).
  • Generates architecture diagrams following the 5-element framework (components, relationships, arrows, colors, numbers) and provides guidance for Logical/Physical/Service/Data/Flow diagrams.
  • Useful for design proposals, architecture overviews, post-mortems, system overviews, and wiki-ready documentation.

Quick Start

Draft a complete Lark-styled technical document for a given system, using the 4-section template and Mermaid diagrams.

Frequently Asked Questions about lark-tech-doc-writer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate standardized technical documentation for Lark Wiki?▼

To generate standardized technical documentation for Lark Wiki, this Skill enforces a strict 4-section template (Glossary, Background, Problem, Solution) and applies YAML frontmatter-based discovery to ensure publish-ready outputs.

What is the best way to create Mermaid and PlantUML architecture diagrams for technical docs?▼

Creating Mermaid and PlantUML architecture diagrams is handled by applying a 5-element framework (components, relationships, arrows, colors, numbers) that provides specific guidance for Logical, Physical, Service, Data, and Flow diagrams.

Can I use this to write post-mortems and design proposals, or is it only for architecture overviews?▼

Yes, you can use this for post-mortems and design proposals, as it supports system overviews and various template-driven technical documents, ensuring consistent formatting across all document types.

Does this enforce specific formatting guidelines for UML diagrams in Lark?▼

Yes, it enforces formatting guidelines for UML diagrams in Lark by implementing structure enforcement and strict template rules described in the Skill specification, ensuring consistent diagram outputs.

What structure must a design document follow to be publish-ready in Lark Wiki?▼

A publish-ready design document in Lark Wiki must follow the 4-section template (Glossary, Background, Problem, Solution) and include YAML frontmatter for discovery, structure enforcement, and formatting compliance.

Related Skills

Explore More Content & Communication Skills→
hffmnnjhffmnnj
39

research

Research technologies and patterns, producing a RESEARCH.md with sources and recommendations.

Community
Basic
LusciiLuscii

mermaid-diagrams

Create Mermaid diagrams in Markdown files for visualizing workflows, architecture, and data models.

Official
Basic
LerianStudioLerianStudio
205

competitive-intelligence

Analyzes competitive landscape and creates battlecards for sales enablement.

Official
Intermediate
MykalMachonMykalMachon
3

technical-writer

Generate READMEs, specifications, architecture documents, and runbooks from templates.

Community
Intermediate