ReSpec is a JS library that makes it easier to write technical specifications, or documents that tend to be technical in nature in general. It was originally designed for the purpose of writing W3C specifications, but has since grown to be able to support other outputs as well.

If you are just interested in writing a spec, you can grab the starter spec.

We have extensive documentation on how to use ReSpec in our wiki, including:

• User's guide
• WebIDL guide

You don't need to check-out or fork this repository.

If you are new to spec writing, we strongly encourage you to read:

• API Design Principles
• Writing Promise-Using Specifications
• Privacy and Security Self-Review Questionnaire
• Short i18n review checklist
• Adding another permission? A guide

If you experience issues, please email [email protected] or if you think something is broken, file a bug.

Please note: ReSpec is not endorsed by W3C and nobody should expect the W3C Webmaster to provide advice on problems encountered with ReSpec, or on why it may be failing to produce pubrules-compliant content.

Bibliographical references have been moved out of ReSpec. You want to use specref.org.

Documentation for ReSpec is available in our wiki.

Please see our developer guide.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

This project exists thanks to all the people who contribute. [Contribute].

Thank you to all our backers! 🙏 [Become a backer]

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]