Controlled Natural Language for Requirements Specifications

REQUS is a controlled natural language (CNL) for requirements specifications. It is explained in detail in this paper, which was published in the ACM SIGPLAN International Workshop on Beyond Code: No Code (BCNC). More details about REQUS syntax you can find at www.requs.org.

In order to use it in a Java project, just add this plugin to your pom.xml:

<reporting>
  <plugins>
    <plugin>
      <groupId>org.requs</groupId>
      <artifactId>requs-maven-plugin</artifactId>
      <version>1.17.0</version>
    </plugin>
  </plugins>
</reporting>

Then, add REQUS files to src/main/requs and name them as main.req, etc.

Then, run mvn clean site and you will see a report at target/site/requs.

How to contribute?

Fork the repository, make changes, submit a pull request. We promise to review your changes same day and apply to the master branch, if they look correct.

Please run Maven build before submitting a pull request:

mvn clean install -Pqulice

To render the site and edit its pages:

cd jekyll
bundle install
bundle exec jekyll serve --drafts