writing-project-technical-writing

Community

Maintain project's technical writing voice.

Authorkylehughes
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill ensures all technical writing within the project adheres to a consistent, professional, and developer-centric voice, preventing AI-generated content and maintaining clarity.

Core Features & Use Cases

  • Voice and Tone Consistency: Enforces a pragmatic, direct, and confident tone suitable for developer-to-developer communication.
  • Style Guide Adherence: Provides clear guidelines on pronoun usage, tense, and instruction phrasing.
  • Anti-Pattern Avoidance: Lists specific words and patterns to avoid, such as enthusiasm markers and filler words.
  • Document Structure Templates: Offers templates for READMEs, ADRs, and code documentation.
  • Use Case: When writing a new README for a Swift package, use this Skill to ensure the description, getting started guide, and architecture sections follow the established voice and structure.

Quick Start

Write a new README file for the 'Networking' module, ensuring it follows the project's established voice and structure guidelines.

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: writing-project-technical-writing
Download link: https://github.com/kylehughes/knapsack/archive/main.zip#writing-project-technical-writing

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.