skills.rest
finos
finosOFFICIAL
Explore all skills by this author →
WebsiteGitHub

technical-writer

Transform complex Morphir-dotnet concepts into publish-ready Hugo/Docsy documentation.

14|12|Updated Mar 30, 2020
One-click install
npx skills add https://github.com/finos/morphir-dotnet --skill technical-writer-finos
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/finos/morphir-dotnet/tree/main/.claude/skills/technical-writer
Command: npx skills add https://github.com/finos/morphir-dotnet --skill technical-writer-finos

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill makes technical writing and documentation efficient by transforming complex Morphir-dotnet concepts into clear, structured, publish-ready content, including Hugo/Docsy site docs, API references, and diagrams.

Core Features & Use Cases

  • Documentation strategy: design navigation, templates, and governance for consistent docs.
  • Hugo/Docsy mastery: troubleshoot builds, configure navigation, and customize themes.
  • Visual communication: create Mermaid/PlantUML diagrams to illustrate architectures and flows.
  • API documentation: ensure XML docs coverage and API references.
  • Content governance: perform quarterly audits, maintain style guide, and manage documentation backlog.

Quick Start

To begin, describe your documentation task to the skill, for example: "Document the new Morphir CLI command with API references and a quick start guide." The Skill will propose a structured plan, draft the content, and suggest diagrams or tutorials as needed.

Frequently Asked Questions about technical-writer

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

FAQPage Schema
How do I write API documentation for Morphir-dotnet?▼

To write API documentation for Morphir-dotnet, apply XML documentation patterns to ensure full API reference coverage, then structure the content using frontmatter-driven Markdown for publish-ready output.

How do I troubleshoot Hugo and Docsy site navigation and theme builds?▼

Troubleshoot Hugo and Docsy site builds by configuring navigation menus, customizing themes, and applying consistent frontmatter-driven structures to resolve layout and build errors efficiently.

How do I create Mermaid and PlantUML diagrams for software architecture?▼

Create Mermaid and PlantUML diagrams to illustrate software architectures and flows by embedding the diagram code directly within your Markdown documentation for visual communication.

What is documentation governance and how do I maintain a style guide?▼

Documentation governance involves performing quarterly content audits, maintaining a consistent style guide, and managing a documentation backlog to ensure long-term content quality.

Can I document a new CLI command with both API references and a quick start guide?▼

Yes, you can document a new CLI command by generating a structured plan that drafts API references, creates quick start tutorials, and suggests illustrative diagrams.

Related Skills

finosfinos
14

morphir-architect

Guide Morphir AST/IR design and code generation for morphir-dotnet.

Official
Advanced
mahg-esmahg-es
3

static-site-generate

Generate static websites from Markdown into deployable HTML with CI workflows.

Official
Intermediate
VictorSmaniottoVictorSmaniotto

diagram-generator

Generate Mermaid and PlantUML definitions for data models, workflows, and system architecture.

Community
Advanced
hdickohdicko

hugo

Build, configure, and deploy Hugo static sites with Go templates and Hugo Pipes.

Community
Advanced