Why does the Tech Writer skill forbid emojis in documentation?

Emojis are restricted to prevent Windows binary compilation errors caused by charmap encoding issues, ensuring documentation is portable across all systems.

How does the ADR creation process work?

The skill identifies the next sequential number in your decisions directory, applies a standard template (Status, Context, Decision, Consequences), and creates the correctly named Markdown file.

What is the recommended line length for documentation?

The skill enforces a maximum of 120 characters per line, which aligns with modern linting configurations like ruff for better readability and cleaner git diffs.

Can I use this for README files?

Yes, the skill includes specific structures for project READMEs, covering overview, installation, usage, and contribution sections using best practices.

Does this skill change American English in code identifiers?

No, the skill is designed to preserve American spellings in code identifiers, APIs, and technical terms while enforcing British English in prose and descriptions.

Tech Writer

Name: Tech Writer
Author: DiamondLightSource

byDiamondLightSource

0•

学习与文档

Standardises technical documentation using British English conventions, structured ADR templates, and strict Markdown formatting rules.

The Tech Writer skill is a specialised tool designed to automate and maintain high-quality documentation standards within technical projects. It enforces British English spelling and grammar, ensures a strict 120-character line limit for better version control, and prohibits emojis to prevent compilation issues in specific environments. By providing structured templates for Architecture Decision Records (ADRs) and README files, it enables developers to create consistent, professional, and accessible documentation that aligns with the SmartEM project standards and the Diataxis framework.

主要功能

01Automates the creation of Architecture Decision Records (ADRs) with sequential numbering.

020 GitHub stars

03Maintains strict Markdown formatting including a 120-character line limit and emoji-free content.

04Provides standardised templates for project READMEs, user guides, and API docs.

05Integrates with npm-based documentation build systems and navigation configurations.

06Enforces British English spelling and grammar across all project documentation.

使用场景

01Standardising multi-repository READMEs for visual and structural consistency.

02Formalising architectural changes through the structured ADR workflow.

03Reviewing and migrating documentation to comply with British English and line-length standards.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add diamondlightsource/smartem-devtools tech-writer

For use in Claude.ai and ChatGPT

Download Skill