{"id":796,"date":"2024-11-25T14:12:04","date_gmt":"2024-11-25T13:12:04","guid":{"rendered":"https:\/\/kunden.weissblaumedia.de\/reinschke\/?p=796"},"modified":"2024-12-09T08:08:40","modified_gmt":"2024-12-09T07:08:40","slug":"wie-koennen-teilautomatisiert-erstellte-technische-dokumente-effizient-gereviewt-und-freigegeben-werden","status":"publish","type":"post","link":"https:\/\/autoconformance.com\/en\/wie-koennen-teilautomatisiert-erstellte-technische-dokumente-effizient-gereviewt-und-freigegeben-werden\/","title":{"rendered":"How can semi-automatically generated documents be reviewed efficiently?"},"content":{"rendered":"<p>[et_pb_section fb_built=\u201d1\u2033 admin_label=\u201dsection\u201d _builder_version=\u201d4.16\u2033 custom_padding=\u201d40px|||||\u201d da_disable_devices=\u201doff|off|off\u201d global_colors_info=\u201d{}\u201d da_is_popup=\u201doff\u201d da_exit_intent=\u201d off&quot; da_has_close=&quot;on&quot; da_alt_close=\u201doff\u201d da_dark_close=\u201doff\u201d da_not_modal=\u201don\u201d da_is_singular=\u201doff\u201d da_with_loader=\u201doff\u201d da_has_shadow=\u201don\u201d][et_pb_row admin_label=\u201drow\u201d _builder_version=\u201d4.16\u2033 background_size=\u201dinitial\u201d background_position= \u201ctop_left\u201d background_repeat=\u201crepeat\u201d custom_padding=\u201d3px||3px|||\u201d global_colors_info=\u201d{}\u201d][et_pb_column type=\u201d4_4\u2033 _builder_version=\u201d4.16\u2033 custom_padding=\u201d|||\u201d global_colors_info=\u201d{}\u201d custom_padding__hover=\u201d|||\u201d ][et_pb_text admin_label=\u201cText\u201d _builder_version=\u201c4.27.3\u2033 background_size=\u201cinitial\u201d background_position=\u201ctop_left\u201d background_repeat=\u201crepeat\u201d global_colors_info=\u201c{}\u201c]<\/p>\n<h2>1. Introduction<\/h2>\n<p>Technical documents that have been created semi-automatically are often very extensive. When developing a product according to the <strong>V-model<\/strong> the following technical documents are created, among others:<\/p>\n<ul>\n<li>design specifications,<\/li>\n<li>analysis documents,<\/li>\n<li>requirement documents,<\/li>\n<li>test specifications and test reports.<\/li>\n<\/ul>\n<p><strong>Document reviews<\/strong> serve to uncover gaps and systematic errors in the documents. This article describes how technical documents can be reviewed in an effective and efficient manner.<\/p>\n<h2>2. Effective and efficient review of technical documents<\/h2>\n<p>A review can take two forms:<\/p>\n<ul>\n<li><strong>Walk-through review<\/strong>: The author guides the participants through the document.<\/li>\n<li><strong>Inspection review<\/strong>: Each participant reads the document independently.<\/li>\n<\/ul>\n<h3>Steps for optimal review preparation<\/h3>\n<blockquote>\n<p>\u201cA successful review depends on selecting the right participants and defining the right review criteria.\u201d<\/p>\n<\/blockquote>\n<p>For each chapter or section of the document to be reviewed, determine:<\/p>\n<ul>\n<li>Who is a <strong>responsible person<\/strong> for the content?<\/li>\n<li>Who is a <strong>\"project-internal customer\",<\/strong> who needs the content?<\/li>\n<\/ul>\n<p>Sections without \"project-internal customers\" should be deleted. The review criteria are jointly defined by the review team to ensure that there is a common understanding and that all relevant aspects are covered.<\/p>\n<h3>Conducting the review<\/h3>\n<p>The review should be conducted as follows:<\/p>\n<ul>\n<li>Partition the document into review parts,<\/li>\n<li>Assign each review part to more than one review participant, preferably to all project-internal customers of the review part,<\/li>\n<li>Once all review participants have provided their review comments, discuss the review comments in a joint session of all review participants and determine the necessary corrections.<\/li>\n<\/ul>\n<p>As soon as all corrections have been incorporated, the document can be released.<\/p>\n<p>[\/et_pb_text][et_pb_image src=\u201dhttps:\/\/autoconformance.com\/wp-content\/uploads\/2024\/11\/reviews.jpg\u201d title_text=\u201dreviews\u201d show_in_lightbox=\u201don\u201d _builder_version=\u201d4.27.3\u2033 _module_preset= &quot;default&quot; global_colors_info=\u201d{}\u201d][\/et_pb_image][et_pb_text admin_label=\u201dText\u201d _builder_version=\u201d4.27.3\u2033 background_size=\u201dinitial\u201d background_position=\u201dtop_left\u201d background_repeat=\u201drepeat\u201d global_colors_info=\u201d{}\u201d]<\/p>\n<h2>3. Advantages of semi-automatically created documents<\/h2>\n<p>Semi-automatically created documents exhibit the following advantages:<\/p>\n<ul>\n<li><strong>Consistent structure:<\/strong> The document structure is predefined.<\/li>\n<li><strong>Automatic error detection:<\/strong> Missing or inconsistent entries can be identified automatically.<\/li>\n<li><strong>No spelling mistakes:<\/strong> Autogenerated texts are standardized.<\/li>\n<\/ul>\n<blockquote>\n<p>\u201cTrivial errors such as missing entries or inconsistent links are detected automatically, preferably prior to the review.\u201d<\/p>\n<\/blockquote>\n<h3>Limits of automation<\/h3>\n<p>Certain mistakes can only be detected manually, such as:<\/p>\n<ul>\n<li>Incorrect assumptions (e.g. maximum incoming disturbances or interferences),<\/li>\n<li>Suboptimal design decisions (e.g. in the system architecture).<\/li>\n<\/ul>\n<h2>4. Summary<\/h2>\n<p>The review of technical documents can be made efficient by:<\/p>\n<ul>\n<li>involving primarily the \u201cproject-internal customers\u201d in the review,<\/li>\n<li>deleting document parts without \u201cproject-internal customers\u201d, and<\/li>\n<li>the review team defining and accepting on such review criteria that cannot be checked automatically.<\/li>\n<\/ul>\n<p>The autoConform\u00ae software supports the review process by providing automated document checks and by automating traceability. This allows review participants to focus on content errors and minimize the time spent on reviews.<\/p>\n<p>[\/et_pb_text][et_pb_image src=\u201dhttps:\/\/autoconformance.com\/wp-content\/uploads\/2024\/11\/developer-team-software.jpg\u201d title_text=\u201ddeveloper-team-software\u201d show_in_lightbox=\u201don\u201d _builder_version =\u201c4.27.3\u2033 _module_preset=\u201cdefault\u201c global_colors_info=&quot;{}&quot;][\/et_pb_image][\/et_pb_column][\/et_pb_row][\/et_pb_section]<\/p>","protected":false},"excerpt":{"rendered":"<p>Technical documents that are created semi-automatically and are intended to be complete are often very extensive. Find out more about how you can organize the review and approval of these documents in a time- and cost-saving manner.<\/p>","protected":false},"author":1,"featured_media":964,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_et_pb_use_builder":"on","_et_pb_old_content":"<!-- wp:paragraph -->\r\n<p>Willkommen bei WordPress. Dies ist dein erster Beitrag. Bearbeite oder l\u00f6sche ihn und beginne mit dem Schreiben!<\/p>\r\n<!-- \/wp:paragraph -->","_et_gb_content_width":"","footnotes":""},"categories":[1],"tags":[],"class_list":["post-796","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-allgemein"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v24.1 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Wie k\u00f6nnen teilautomatisiert erstellte Dokumente effizient gereviewt werden? - automated conformance GmbH<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/autoconformance.com\/en\/wie-koennen-teilautomatisiert-erstellte-technische-dokumente-effizient-gereviewt-und-freigegeben-werden\/\" \/>\n<meta property=\"og:locale\" content=\"en_GB\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Wie k\u00f6nnen teilautomatisiert erstellte Dokumente effizient gereviewt werden? - automated conformance GmbH\" \/>\n<meta property=\"og:description\" content=\"Teilautomatisiert erstellte technische Dokumente, die den Anspruch auf Vollst\u00e4ndigkeit haben, sind oft sehr umfangreich. Erfahren Sie mehr dar\u00fcber, wie Sie das Review und die Freigabe dieser Dokumente zeit- und kostensparend organisieren k\u00f6nnen.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/autoconformance.com\/en\/wie-koennen-teilautomatisiert-erstellte-technische-dokumente-effizient-gereviewt-und-freigegeben-werden\/\" \/>\n<meta property=\"og:site_name\" content=\"automated conformance GmbH\" \/>\n<meta property=\"article:published_time\" content=\"2024-11-25T13:12:04+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2024-12-09T07:08:40+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/autoconformance.com\/wp-content\/uploads\/2024\/11\/wissenwertes-1.png\" \/>\n\t<meta property=\"og:image:width\" content=\"330\" \/>\n\t<meta property=\"og:image:height\" content=\"48\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"author\" content=\"weissblau media\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"weissblau media\" \/>\n\t<meta name=\"twitter:label2\" content=\"Estimated reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/autoconformance.com\/wie-koennen-teilautomatisiert-erstellte-technische-dokumente-effizient-gereviewt-und-freigegeben-werden\/\",\"url\":\"https:\/\/autoconformance.com\/wie-koennen-teilautomatisiert-erstellte-technische-dokumente-effizient-gereviewt-und-freigegeben-werden\/\",\"name\":\"Wie k\u00f6nnen teilautomatisiert erstellte Dokumente effizient gereviewt werden? - automated conformance GmbH\",\"isPartOf\":{\"@id\":\"https:\/\/autoconformance.com\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/autoconformance.com\/wie-koennen-teilautomatisiert-erstellte-technische-dokumente-effizient-gereviewt-und-freigegeben-werden\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/autoconformance.com\/wie-koennen-teilautomatisiert-erstellte-technische-dokumente-effizient-gereviewt-und-freigegeben-werden\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/autoconformance.com\/wp-content\/uploads\/2024\/11\/wissenwertes-1.png\",\"datePublished\":\"2024-11-25T13:12:04+00:00\",\"dateModified\":\"2024-12-09T07:08:40+00:00\",\"author\":{\"@id\":\"https:\/\/autoconformance.com\/#\/schema\/person\/ed1e02d220d6626f0f581c69fdcb8fe5\"},\"breadcrumb\":{\"@id\":\"https:\/\/autoconformance.com\/wie-koennen-teilautomatisiert-erstellte-technische-dokumente-effizient-gereviewt-und-freigegeben-werden\/#breadcrumb\"},\"inLanguage\":\"en-GB\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/autoconformance.com\/wie-koennen-teilautomatisiert-erstellte-technische-dokumente-effizient-gereviewt-und-freigegeben-werden\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-GB\",\"@id\":\"https:\/\/autoconformance.com\/wie-koennen-teilautomatisiert-erstellte-technische-dokumente-effizient-gereviewt-und-freigegeben-werden\/#primaryimage\",\"url\":\"https:\/\/autoconformance.com\/wp-content\/uploads\/2024\/11\/wissenwertes-1.png\",\"contentUrl\":\"https:\/\/autoconformance.com\/wp-content\/uploads\/2024\/11\/wissenwertes-1.png\",\"width\":330,\"height\":48,\"caption\":\"Ein Icon mit Gl\u00fchbirne und Zahnrad, das f\u00fcr Wissen, Kreativit\u00e4t und technische Innovationen bei automated conformance steht\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/autoconformance.com\/wie-koennen-teilautomatisiert-erstellte-technische-dokumente-effizient-gereviewt-und-freigegeben-werden\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Startseite\",\"item\":\"https:\/\/autoconformance.com\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Wie k\u00f6nnen teilautomatisiert erstellte Dokumente effizient gereviewt werden?\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/autoconformance.com\/#website\",\"url\":\"https:\/\/autoconformance.com\/\",\"name\":\"automated conformance GmbH\",\"description\":\"Software- und Ingenieurdienstleistungen f\u00fcr sicherheitskritische Produkte\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/autoconformance.com\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-GB\"},{\"@type\":\"Person\",\"@id\":\"https:\/\/autoconformance.com\/#\/schema\/person\/ed1e02d220d6626f0f581c69fdcb8fe5\",\"name\":\"weissblau media\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-GB\",\"@id\":\"https:\/\/autoconformance.com\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/bbb409da4970da9446f6c49465d453cb8a0dae301e4d4f465b5c4e62408daa2e?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/bbb409da4970da9446f6c49465d453cb8a0dae301e4d4f465b5c4e62408daa2e?s=96&d=mm&r=g\",\"caption\":\"weissblau media\"},\"sameAs\":[\"https:\/\/autoconformance.com\"]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Wie k\u00f6nnen teilautomatisiert erstellte Dokumente effizient gereviewt werden? - automated conformance GmbH","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/autoconformance.com\/en\/wie-koennen-teilautomatisiert-erstellte-technische-dokumente-effizient-gereviewt-und-freigegeben-werden\/","og_locale":"en_GB","og_type":"article","og_title":"Wie k\u00f6nnen teilautomatisiert erstellte Dokumente effizient gereviewt werden? - automated conformance GmbH","og_description":"Teilautomatisiert erstellte technische Dokumente, die den Anspruch auf Vollst\u00e4ndigkeit haben, sind oft sehr umfangreich. Erfahren Sie mehr dar\u00fcber, wie Sie das Review und die Freigabe dieser Dokumente zeit- und kostensparend organisieren k\u00f6nnen.","og_url":"https:\/\/autoconformance.com\/en\/wie-koennen-teilautomatisiert-erstellte-technische-dokumente-effizient-gereviewt-und-freigegeben-werden\/","og_site_name":"automated conformance GmbH","article_published_time":"2024-11-25T13:12:04+00:00","article_modified_time":"2024-12-09T07:08:40+00:00","og_image":[{"width":330,"height":48,"url":"https:\/\/autoconformance.com\/wp-content\/uploads\/2024\/11\/wissenwertes-1.png","type":"image\/png"}],"author":"weissblau media","twitter_card":"summary_large_image","twitter_misc":{"Written by":"weissblau media","Estimated reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/autoconformance.com\/wie-koennen-teilautomatisiert-erstellte-technische-dokumente-effizient-gereviewt-und-freigegeben-werden\/","url":"https:\/\/autoconformance.com\/wie-koennen-teilautomatisiert-erstellte-technische-dokumente-effizient-gereviewt-und-freigegeben-werden\/","name":"Wie k\u00f6nnen teilautomatisiert erstellte Dokumente effizient gereviewt werden? - automated conformance GmbH","isPartOf":{"@id":"https:\/\/autoconformance.com\/#website"},"primaryImageOfPage":{"@id":"https:\/\/autoconformance.com\/wie-koennen-teilautomatisiert-erstellte-technische-dokumente-effizient-gereviewt-und-freigegeben-werden\/#primaryimage"},"image":{"@id":"https:\/\/autoconformance.com\/wie-koennen-teilautomatisiert-erstellte-technische-dokumente-effizient-gereviewt-und-freigegeben-werden\/#primaryimage"},"thumbnailUrl":"https:\/\/autoconformance.com\/wp-content\/uploads\/2024\/11\/wissenwertes-1.png","datePublished":"2024-11-25T13:12:04+00:00","dateModified":"2024-12-09T07:08:40+00:00","author":{"@id":"https:\/\/autoconformance.com\/#\/schema\/person\/ed1e02d220d6626f0f581c69fdcb8fe5"},"breadcrumb":{"@id":"https:\/\/autoconformance.com\/wie-koennen-teilautomatisiert-erstellte-technische-dokumente-effizient-gereviewt-und-freigegeben-werden\/#breadcrumb"},"inLanguage":"en-GB","potentialAction":[{"@type":"ReadAction","target":["https:\/\/autoconformance.com\/wie-koennen-teilautomatisiert-erstellte-technische-dokumente-effizient-gereviewt-und-freigegeben-werden\/"]}]},{"@type":"ImageObject","inLanguage":"en-GB","@id":"https:\/\/autoconformance.com\/wie-koennen-teilautomatisiert-erstellte-technische-dokumente-effizient-gereviewt-und-freigegeben-werden\/#primaryimage","url":"https:\/\/autoconformance.com\/wp-content\/uploads\/2024\/11\/wissenwertes-1.png","contentUrl":"https:\/\/autoconformance.com\/wp-content\/uploads\/2024\/11\/wissenwertes-1.png","width":330,"height":48,"caption":"Ein Icon mit Gl\u00fchbirne und Zahnrad, das f\u00fcr Wissen, Kreativit\u00e4t und technische Innovationen bei automated conformance steht"},{"@type":"BreadcrumbList","@id":"https:\/\/autoconformance.com\/wie-koennen-teilautomatisiert-erstellte-technische-dokumente-effizient-gereviewt-und-freigegeben-werden\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Startseite","item":"https:\/\/autoconformance.com\/"},{"@type":"ListItem","position":2,"name":"Wie k\u00f6nnen teilautomatisiert erstellte Dokumente effizient gereviewt werden?"}]},{"@type":"WebSite","@id":"https:\/\/autoconformance.com\/#website","url":"https:\/\/autoconformance.com\/","name":"automated conformance GmbH","description":"Software- und Ingenieurdienstleistungen f\u00fcr sicherheitskritische Produkte","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/autoconformance.com\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-GB"},{"@type":"Person","@id":"https:\/\/autoconformance.com\/#\/schema\/person\/ed1e02d220d6626f0f581c69fdcb8fe5","name":"weissblau media","image":{"@type":"ImageObject","inLanguage":"en-GB","@id":"https:\/\/autoconformance.com\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/bbb409da4970da9446f6c49465d453cb8a0dae301e4d4f465b5c4e62408daa2e?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/bbb409da4970da9446f6c49465d453cb8a0dae301e4d4f465b5c4e62408daa2e?s=96&d=mm&r=g","caption":"weissblau media"},"sameAs":["https:\/\/autoconformance.com"]}]}},"_links":{"self":[{"href":"https:\/\/autoconformance.com\/en\/wp-json\/wp\/v2\/posts\/796","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/autoconformance.com\/en\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/autoconformance.com\/en\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/autoconformance.com\/en\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/autoconformance.com\/en\/wp-json\/wp\/v2\/comments?post=796"}],"version-history":[{"count":18,"href":"https:\/\/autoconformance.com\/en\/wp-json\/wp\/v2\/posts\/796\/revisions"}],"predecessor-version":[{"id":1477,"href":"https:\/\/autoconformance.com\/en\/wp-json\/wp\/v2\/posts\/796\/revisions\/1477"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/autoconformance.com\/en\/wp-json\/wp\/v2\/media\/964"}],"wp:attachment":[{"href":"https:\/\/autoconformance.com\/en\/wp-json\/wp\/v2\/media?parent=796"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/autoconformance.com\/en\/wp-json\/wp\/v2\/categories?post=796"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/autoconformance.com\/en\/wp-json\/wp\/v2\/tags?post=796"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}