Objective-Arts
Objective-Arts/lens-dist
相关职业SOC
基于 SOC 职业分类
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
直接命令不会经过审查 Prompt；运行前请先检查来源。
npx skills add https://github.com/Objective-Arts/lens-dist --skill editing命令会保持在同一行。复制前请横向滚动并检查完整内容。
想先保存到本地？可下载 SkillsMP 当前能够提供的文件。
基于 SOC 职业分类
正在显示 SKILL.md
| name | editing |
| description | On Writing - kill your darlings, practical writing advice |
Apply Stephen King's practical, no-nonsense writing advice to technical documentation and code.
"Kill your darlings, kill your darlings, even when it breaks your egocentric little scribbler's heart, kill your darlings."
The phrase you're most proud of? Cut it. The clever comment you admire? Delete it. If you love it too much, it's probably self-indulgent and doesn't serve the reader.
Use the first word that comes to mind, if it's appropriate. Don't dress up your vocabulary.
Bad (pretentious):
// Instantiate a new configuration object and effectuate
// the necessary parameterization for optimal functionality
Good (plain):
// Create a config object with default settings
"One of the really bad things you can do to your writing is to dress up the vocabulary."
Know the rules so you can break them deliberately.
The most important rule: Subject-Verb-Object. Keep it simple.
"Passive voice is weak and safe."
The passive voice creates distance, avoids responsibility, and bores the reader.
Passive: "The error was handled by the catch block" Active: "The catch block handles the error"
"The road to hell is paved with adverbs."
Adverbs are a sign of weak verbs. Find a stronger verb instead.
| Weak | Strong |
|---|---|
| "ran quickly" | "sprinted" |
| "said loudly" | "shouted" |
| "very important" | "critical" |
| "totally broken" | "broken" |
| "really fast" | "fast" |
First draft is just you. Write without thinking about the audience. Get it down.
For code: Write the first version of documentation as notes to yourself.
Second draft is for readers. Cut, clarify, restructure.
For code: Revise documentation imagining a tired developer at 2am.
Second Draft = First Draft - 10%
Whatever you wrote, cut at least 10%. If you wrote 1000 words, you should end with 900 or fewer.
Before (your darling):
// Here be dragons! This function is a labyrinth of
// Minotaur-like complexity where many a brave developer
// has lost their way. Proceed with caution and a ball of yarn.
After (killed):
// Complex validation logic - see docs/validation.md for details
Before (your darling):
## A Brief History of Configuration Management
In the early days of computing, configuration was handled
through punched cards. As technology evolved, we moved to
flat files, then INI files, and eventually to the elegant
YAML format we use today...
After (killed):
## Configuration
Edit `config.yaml` to customize settings.
Before (your darling):
// Like a phoenix rising from the ashes, this retry logic
// gives our failed requests a second chance at life
async function retryRequest() { ... }
After (killed):
// Retry failed requests up to 3 times
async function retryRequest() { ... }
"If you want to be a writer, you must do two things above all others: read a lot and write a lot."
For technical writing: Read good documentation. Read bad documentation. Know the difference.
The only way to get better is to practice. Write commit messages with care. Write comments thoughtfully. Every piece of writing is practice.
Tell:
This function is very efficient and fast.
Show:
Processes 1M records in <100ms.
"Writing is not life, but I think that sometimes it can be a way back to life."
Write honestly. If something is hard, say it's hard. If there's a hack, call it a hack. Readers respect honesty.
"I'm convinced that fear is at the root of most bad writing."
Bad writing comes from fear:
Good writing is fearless writing.