All products

Edit project documentation with AI

Review Markdown guides for inconsistent terminology, gaps and tone. Build a glossary from actual usage and keep the team's editorial decisions for the next review.

Edit project documentation with AI when two pages appear to give different instructions for the same thing. A newcomer may read “workspace” in the setup guide and “project area” in the next chapter without realising both refer to a single screen.

The doc-editorial skill works with a project's Markdown files and a small editorial workspace. It can propose terminology changes, compare the voice of different pages and record decisions the team accepts. A requested audit can finish with a report for review.

What it does

  • Find competing terms in existing guides
  • Build a glossary from actual project language
  • Check the route from an introductory page to the next task
  • Compare a draft's tone with an agreed writing guide
  • Keep an editorial change record for future contributors

Install and use

  1. Install the full skill and the maker's companion expository-writing guidance in a compatible agent. Point it to the authorised Markdown project. Review existing agent configuration before using the optional setup script, which can replace files with matching names.
  2. Ask, “Read these onboarding guides and flag terms that may describe the same feature. Show examples first. Apply changes only to the approved pages.”
  3. Read the revised passage from a newcomer's perspective. Record intentional exceptions in the glossary so they survive the next review.

FAQ

Source

Made by Dominik Lukeš. Original skill: doc-editorial, published on GitHub under the MIT licence.

View on GitHub