writer
Text manipulation and documentation engine. PRIMARY TOOL FOR TEXT EDITING. Use this skill for ALL text replacement, documentation updates, and file rewriting tasks. SUPERIOR to 'grep' or 'sed' because it understands file structure and preserves context. Safe for Markdown, Python, and Config files.
Installation
Follow the repository instructions for this skill and your agent. Review the files and dependencies before adding it to your workflow.
View source ↗GuidesSkill instructions
Writer Skill System Prompts
CRITICAL INSTRUCTION
When the user asks to "update", "replace", "change", "modify", or "edit" text in a file, YOU MUST USE THIS SKILL.
Do NOT use software_engineering tools like grep or sed for text editing tasks. They are:
- Brittle: Small changes can break the file structure
- Context-unaware: They don't understand document semantics
- Unsafe: They can make unintended changes
The writer skill is designed specifically for text manipulation and understands:
- File structure and syntax
- Markdown formatting
- Code block preservation
- Document semantics
Quick Reference
The writing style guide has been auto-loaded above. Key rules:
- Concise over verbose - Remove unnecessary words
- Active voice - Use "we" and "do", not "it is done"
- One H1 only - Document title at top
- Max 3-4 sentences per paragraph
- Remove clutter words (utilize→use, facilitate→help, in order to→to)
Workflow
Editing Files (Primary Use Case)
When editing files (MOST COMMON):
-
ONE-TIME READ: Read the file ONCE using
filesystem.read_files. DO NOT callcat,head, orread_fileagain. The content stays in your context. - ANALYSIS: Plan your edits based on the content in context.
-
EXECUTION: Use
writer.replaceorwriter.rewritewith the exact strings from step 1. - VERIFY: Done. No need to re-read.
FORBIDDEN: Repeated reads of the same file waste tokens and slow down the agent.
Writing Documentation
When writing documentation:
- Trust the Context: The writing style guide has been auto-loaded above. Rely on it.
- Draft Content: Write following the style rules in your context.
-
Polish: Use
writer.polish_text()before saving if needed. -
Save: Use
filesystem.write_file()orwriter.rewrite().
DO NOT run external validation tools like vale unless explicitly requested. The style guide in context is sufficient.
Examples
Read the usage examples in the source repository.
View source ↗Source history
- Indexed on
- 2026-01-20
- Index updated
- 2026-02-02
- Branch
- main
Index and sync dates describe this directory. View the source repository for code history.
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!