{"id":4764,"date":"2013-09-27T06:58:19","date_gmt":"2013-09-27T13:58:19","guid":{"rendered":"http:\/\/www.technosolutions.com\/kb\/?p=4764"},"modified":"2020-04-19T23:28:09","modified_gmt":"2020-04-20T06:28:09","slug":"how-do-i-author-and-edit-textual-requirements","status":"publish","type":"post","link":"http:\/\/www.technosolutions.com\/kb\/4764\/how-do-i-author-and-edit-textual-requirements\/","title":{"rendered":"How do I author and edit textual Requirements"},"content":{"rendered":"<p><!-- Start ScreenSteps Content --><\/p>\n<div class=\"LessonContent\">\n<div class=\"LessonStep top\">\n<h3 class=\"StepTitle\" style=\"font-size: 20px;\">Requirements Documents<\/h3>\n<div class=\"StepInstructions\">\n<p>In <i>TopTeam<\/i>, all textual requirements go into a <i>Requirements Document<\/i>. You can have one or more <i>Requirements Documents<\/i>, each with their own set of <i>Requirement Types<\/i>, in a project. A default <i>Requirements Document<\/i> is automatically added to each project, you can either add requirements to the default <i>Requirements Document<\/i> or add additional <i>Requirements Documents<\/i>.<\/p>\n<p>Refer to the video\u00a0demonstration <a href=\"http:\/\/www.technosolutions.com\/kb\/3091\/video-getting-started-with-requirements-document-detail\/\" target=\"_blank\" rel=\"noopener\">Video \u2013 Getting Started with Requirements Document Editor<\/a>.<\/p>\n<\/div>\n<\/div>\n<div class=\"LessonStep top\">\n<h3 class=\"StepTitle\" style=\"font-size: 20px;\">Requirement Types<\/h3>\n<div class=\"StepInstructions\">\n<p>When you add a requirement in <i>TopTeam<\/i> repository, it needs to be of a certain <i>Requirement Type<\/i>. <i>TopTeam<\/i> ships with a number of default <i>Requirement Types<\/i> such as <i>Business Requirements, Functional Requirements, Business Rules,<\/i> etc. However, if you need to enter specific <i>Requirement Types<\/i> that are not available in the repository by default, you can create custom <i>Requirement Types<\/i> and add them to <i>Requirements Documents<\/i>.<\/p>\n<\/div>\n<\/div>\n<div class=\"LessonStep top\">\n<h3 class=\"StepTitle\" style=\"font-size: 20px;\">Editors available for authoring and editing textual requirements<\/h3>\n<div class=\"StepInstructions\">\n<p><i>TopTeam<\/i> provides several interfaces for editing requirements. Each editor provides a unique view of the requirements and is best used in a particular usage scenario. You should choose the appropriate interface depending on your current editing goals. The features of the different editors are explained below.<\/p>\n<\/div>\n<\/div>\n<div class=\"LessonStep top\">\n<h3 class=\"StepTitle\" style=\"font-size: 20px;\">1. Repository Explorer<\/h3>\n<div class=\"StepInstructions\">\n<p><i>Repository Explorer <\/i>provides access to all artifacts in the repository, including requirements.<\/p>\n<p>You can expand the <i>Requirements Documents<\/i> node and then expand the desired <i>Requirements Document <\/i>to access the requirements within that document. When you select a requirement on the repository node (left-side repository tree), the corresponding record (detail) editor displays on the right-side pane.<\/p>\n<\/div>\n<\/div>\n<div class=\"LessonStep top\">\n<div class=\"StepImage\" style=\"margin: 10px 0px;\"><img loading=\"lazy\" decoding=\"async\" style=\"padding: 3px; border: 1px solid #ccc;\" src=\"data:image\/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\" data-layzr=\"http:\/\/www.technosolutions.com\/kb\/wp-content\/uploads\/2020\/04\/wpid33101-media_1478596197626.png\" alt=\"wpid33101-media_1478596197626.png\" width=\"749\" height=\"552\" \/><\/div>\n<\/div>\n<div class=\"LessonStep top\">\n<h3 class=\"StepTitle\" style=\"font-size: 20px;\">What is it used for?<\/h3>\n<div class=\"StepInstructions\">\n<p>You can add new, edit and delete requirements in <i>Repository Explorer<\/i>. This interface is sufficient for basic requirements editing.<\/p>\n<\/div>\n<\/div>\n<div class=\"LessonStep top\">\n<h3 class=\"StepTitle\" style=\"font-size: 20px;\">What it does NOT provide?<\/h3>\n<div class=\"StepInstructions\">\n<p>You cannot perform advanced requirements operations such as copying requirements from other projects, changing <i>Requirement Type<\/i>, bulk edit of requirements attributes, etc. in <i>Repository Explorer.<\/i><\/p>\n<p><strong>For a more efficient, user-friendly and powerful interface for editing requirements, use the editors mentioned below.<\/strong><\/p>\n<p>Refer to the video\u00a0demonstration <a href=\"http:\/\/www.technosolutions.com\/kb\/3065\/video-getting-started-with-repository-explorer\/\" target=\"_blank\" rel=\"noopener\">Video \u2013 Getting Started with Repository Explorer<\/a>.<\/p>\n<\/div>\n<\/div>\n<div class=\"LessonStep top\">\n<h3 class=\"StepTitle\" style=\"font-size: 20px;\">2. Requirements Tree Editor<\/h3>\n<div class=\"StepInstructions\">\n<p><i>Requirements Tree<\/i> editor is a hierarchical spreadsheet-like editor for authoring and editing requirements and their attributes.<br \/>\nYou can also create custom <i>Requirement Types<\/i>, for more information, refer to the <a href=\"http:\/\/www.technosolutions.com\/kb\/4569\/how-to-define-a-new-requirement-type\/\" target=\"_blank\" rel=\"noopener\">How to define a new Requirement Type<\/a>.<\/p>\n<\/div>\n<\/div>\n<div class=\"LessonStep top\">\n<div class=\"StepImage\" style=\"margin: 10px 0px;\"><img loading=\"lazy\" decoding=\"async\" style=\"padding: 3px; border: 1px solid #ccc;\" src=\"data:image\/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\" data-layzr=\"http:\/\/www.technosolutions.com\/kb\/wp-content\/uploads\/2020\/04\/wpid33102-media_1478596481850.png\" alt=\"wpid33102-media_1478596481850.png\" width=\"800\" height=\"473\" \/><\/div>\n<\/div>\n<div class=\"LessonStep top\">\n<h3 class=\"StepTitle\" style=\"font-size: 20px;\">What is it used for?<\/h3>\n<div class=\"StepInstructions\">\n<p><i>Requirements Tree<\/i> is available in ribbon toolbar providing various features in different tabs. You can perform basic and advanced editing functions. You can also use <i>Views<\/i> and <i>Filters <\/i>to change or limit display respectively in the<i> Tree.<\/i><\/p>\n<p>Use this editor when you need a concise hierarchical view of requirements, their status and other attributes. You can also perform simultaneous bulk editing of requirements attributes.<\/p>\n<\/div>\n<\/div>\n<div class=\"LessonStep top\">\n<h3 class=\"StepTitle\" style=\"font-size: 20px;\">What it does NOT provide?<\/h3>\n<div class=\"StepInstructions\">\n<p><i>Requirements Tree<\/i> does not provide a single scrolling view that is available in <i>Requirements Document View<\/i> editor (shown below).<\/p>\n<p>Refer to the video\u00a0demonstration <a href=\"http:\/\/www.technosolutions.com\/kb\/3087\/video-getting-started-with-requirements-tree\/\" target=\"_blank\" rel=\"noopener\">Video \u2013 Getting Started with Requirements Tree<\/a>.<\/p>\n<\/div>\n<\/div>\n<div class=\"LessonStep top\">\n<h3 class=\"StepTitle\" style=\"font-size: 20px;\">3. Requirements Document View Editor<\/h3>\n<div class=\"StepInstructions\">\n<p><i>Requirements Document View<\/i> editor is similar to a Word processing editor for authoring and editing requirements.<\/p>\n<\/div>\n<\/div>\n<div class=\"LessonStep top\">\n<div class=\"StepImage\" style=\"margin: 10px 0px;\"><img loading=\"lazy\" decoding=\"async\" style=\"padding: 3px; border: 1px solid #ccc;\" src=\"data:image\/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\" data-layzr=\"http:\/\/www.technosolutions.com\/kb\/wp-content\/uploads\/2020\/04\/wpid33103-media_1478596946212.png\" alt=\"wpid33103-media_1478596946212.png\" width=\"800\" height=\"595\" \/><\/div>\n<\/div>\n<div class=\"LessonStep top\">\n<h3 class=\"StepTitle\" style=\"font-size: 20px;\">What is it used for?<\/h3>\n<div class=\"StepInstructions\">\n<p>You can perform basic and advanced editing functions in <i>Requirements Document Editor<\/i>. You can also use requirements filters to focus and view important requirements in<i> Document View<\/i>.<\/p>\n<p>Use this editor when you need a single scrolling Word processor-like view of all the requirements within a document. You can perform <i>in-place<\/i> <i>editing<\/i> of requirements with the<i> look and feel<\/i> of a Word processor.<\/p>\n<\/div>\n<\/div>\n<div class=\"LessonStep top\">\n<h3 class=\"StepTitle\" style=\"font-size: 20px;\">What it does NOT provide?<\/h3>\n<div class=\"StepInstructions\">\n<p><i>Requirements Document Editor <\/i> does not provide a spreadsheet-like view where you can view and edit attributes of all requirements.<\/p>\n<p>Refer to the video\u00a0demonstration <a href=\"http:\/\/www.technosolutions.com\/kb\/3089\/video-getting-started-with-requirements-document-view\/\" target=\"_blank\" rel=\"noopener\">Video \u2013 Getting Started with Requirements Document View<\/a>.<\/p>\n<\/div>\n<\/div>\n<div class=\"LessonStep top\">\n<h3 class=\"StepTitle\" style=\"font-size: 20px;\">See Also<\/h3>\n<div class=\"StepInstructions\">\n<p><a href=\"http:\/\/www.technosolutions.com\/kb\/4576\/how-to-add-a-requirement-type-to-a-requirements-documentproject\/\" target=\"_blank\" rel=\"noopener\">How to add a Requirement Type to a Requirements Document\/Project<\/a><br \/>\n<a href=\"http:\/\/www.technosolutions.com\/kb\/5747\/authoring-requirements-in-topteam\/\" target=\"_blank\" rel=\"noopener\">Authoring Requirements in TopTeam<\/a><\/p>\n<\/div>\n<\/div>\n<div class=\"LessonStep top\">\n<div class=\"StepInstructions\">\n<p>Revised: April 17th, 2020<\/p>\n<\/div>\n<\/div>\n<\/div>\n<p><!-- End ScreenSteps Content --><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Requirements Documents In TopTeam, all textual requirements go into a Requirements Document. You can have one or more Requirements Documents, each with their own set of Requirement Types, in a project. A default Requirements Document is automatically added to each project, you can either add requirements to the default Requirements Document or add additional Requirements Documents. Refer to the video\u00a0demonstration Video \u2013 Getting Started with Requirements Document Editor. Requirement Types When you add a requirement in TopTeam repository, it needs to be of a certain Requirement Type. TopTeam ships with a number of default Requirement Types such as Business Requirements, <\/p>\n","protected":false},"author":6,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[33],"tags":[286],"class_list":["post-4764","post","type-post","status-publish","format-standard","hentry","category-requirements","tag-requirements"],"jetpack_featured_media_url":"","jetpack_shortlink":"https:\/\/wp.me\/paoaNA-1eQ","_links":{"self":[{"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/posts\/4764","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/users\/6"}],"replies":[{"embeddable":true,"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/comments?post=4764"}],"version-history":[{"count":20,"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/posts\/4764\/revisions"}],"predecessor-version":[{"id":49873,"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/posts\/4764\/revisions\/49873"}],"wp:attachment":[{"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/media?parent=4764"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/categories?post=4764"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/tags?post=4764"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}