Skip to content

Latest commit

 

History

1 Commit

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Writing Coach

A standalone writing coach prompt library for AI-assisted writing diagnostics.

This repository contains a diagnostic writing coach prompt plus the supporting craft framework and usage guide. It is designed for use with AI tools that accept custom prompts, such as Copilot, Obsidian AI, ChatGPT, or similar workflows.

Included files

  • prompts/Writing coach.md — the main prompt definition for diagnosing writing craft.
  • docs/writing_craft.md — the underlying craft principles and coaching signal guide referenced by the prompt.
  • docs/usage.md — CLI usage instructions for installing and running the skill.

How to use

  1. Install the command-line skill with npm install -g ..
  2. Run writing-coach --help or write-better --help for usage options.
  3. Use docs/usage.md for examples and documentation.

Workflow

This tool assembles the Writing Coach prompt and your draft into a package that can be sent to an LLM. The expected flow is:

  1. Run write-better draft.md to generate the coaching prompt.
  2. Send that output to your LLM and receive L1/L2/L3 recommendations.
  3. Optionally, ask the LLM to rewrite the piece according to those recommendations.

Use with Claude / chat-based LLMs

The output is ready to paste directly into a chat window such as Claude or ChatGPT. If you prefer not to use the CLI, open prompts/Writing coach.md, copy the prompt content, paste it into your chat, and then paste your draft below it.

Example:

  1. Run write-better draft.md > coaching_prompt.txt.
  2. Open coaching_prompt.txt and copy everything.
  3. Paste the content into Claude or ChatGPT.
  4. Add a final instruction like: "Please provide L1, L2, and L3 recommendations. Then rewrite the draft according to those recommendations."

Rewrite mode

Use write-better --rewrite draft.md to request recommendations and a rewritten draft in one pass.

Notes

  • This project is intentionally prompt-first; it is not a software program but a self-contained AI coaching module.
  • The feedback format is built to output Obsidian callout blocks, making it easy to paste into ## 寫作診斷 sections in Obsidian.

Attribution

This repository contains a standalone Writing Coach prompt and CLI skill implementation.

About

No description, website, or topics provided.

Resources

Stars

5 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages