Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device. Atlassian cookies and tracking notice, (opens new window)
Confluence
Teams
, (opens new window)
Requirement Yogi (Cloud)
Results will update as you type.
  • Getting Started - Tutorials
    • The RY Macros, and how to write requirements
    • Write requirements in tables
    • Write requirements in paragraphs
  • Best Practices
  • Administrator's guide
  • Features
  • Requirement Yogi for Jira
  • Testing your requirements - Best practices
  • Integrations
  • REST APIs (Cloud)
  • Release notes
    Calendars
You‘re viewing this with anonymous access, so some content might be blocked.
/
Write requirements in paragraphs
Updated Feb 27

    Write requirements in paragraphs

    If you are not one for using tables to write your requirements, it is also possible to write requirements inside paragraphs, or use full documents.

    My paragraph is a requirement

    Requirements in Paragraphs.png
    Paragraph Requirememt.png

    Here, you can see the requirement definition macros are placed inside a paragraph, you can even add some requirement links.

    When using paragraphs, it is not possible to have as many custom properties and relationship names for dependencies as you could have in tables. By default:

    • The description of the requirement is the following sentence.

    • We only index the paragraph where the requirement’s definition is. We do not index the following paragraphs (after skipping a line). The content of the paragraph will be shown as the property ‘Details’ by default.

    • If you put a requirement link in that paragraph, we’ll index it as a dependency of the requirement, with the relationship name ‘Dependency’. Read more in the docs.

    • If you want to have more hand on what we index, and override the name of the property and dependency, you can use the Configuration macro.

    Write requirements as titles for a full document

    Requirements as titles.png
    Traceability Linear documents.png

    If you are working on a big document from your customers, or use public standards. It is possible to use the feature: Linear documents. We will index titles as requirements.

    Please go to the documentation to see more details: Linear documents: Manage requirements outside of tables

    Are we missing your use-case, or do you have more questions? Contact our support.

     

    {"serverDuration": 15, "requestCorrelationId": "eb13f3fc610b48869fa34855b586d1e1"}