Skip to content

Commit

Permalink
modifide overview spelling mistake, added 3LOD & Core Concepts as a t…
Browse files Browse the repository at this point in the history
…opic page
  • Loading branch information
BillBensing committed Aug 22, 2024
1 parent 805637f commit 2d90a87
Show file tree
Hide file tree
Showing 7 changed files with 66 additions and 6 deletions.
4 changes: 3 additions & 1 deletion Writerside/n-nape.tree
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@

<toc-element topic="nape-overview.md"/>
<toc-element topic="getting-started-with-nape.topic">
<toc-element topic="nape-core-concepts.md"/>
<toc-element topic="nape-core-concepts.topic">
<toc-element topic="iia-three-lines-of-defense.topic"/>
</toc-element>
<toc-element topic="installing-nape.md"/>
</toc-element>
<toc-element topic="nape-usecase-and-examples.topic">
Expand Down
2 changes: 1 addition & 1 deletion Writerside/topics/getting-started-with-nape.topic
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

<!-- Add up to 2 topics that you want to promote. Use the "type" attribute to select an icon. -->
<spotlight>
<a href="nape-core-concepts.md" type="learn" summary="This overrides the card summary of the topic">Core Concepts</a>
<a href="nape-core-concepts.topic" type="learn" summary="This overrides the card summary of the topic">Core Concepts</a>
<a href="installing-nape.md" type="settings" summary="This overrides the card summary of the topic">Installing NAPE</a>
</spotlight>

Expand Down
27 changes: 27 additions & 0 deletions Writerside/topics/iia-three-lines-of-defense.topic
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="The IIA Three (3) Lines of Defense" id="iia-three-lines-of-defense">

<p>
Overview articles give background information and provide context to a particular subject.
Their goal is to explain a concept, not to teach or give instructions.
</p>

<chapter title="What is &lt;product/service/concept&gt;" id="overview-chapter" >
<p>Provide some background and context, explain choices and alternatives.</p>
</chapter>
<chapter title="Glossary" id="glossary">
<p>A definition list or a glossary:</p>
<deflist>
<def title="Term1">
This is the definition of the first term.
</def>
<def title="Term2">
This is the definition of the second term.
</def>
</deflist>
</chapter>
</topic>
2 changes: 0 additions & 2 deletions Writerside/topics/nape-core-concepts.md

This file was deleted.

33 changes: 33 additions & 0 deletions Writerside/topics/nape-core-concepts.topic
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="Core Concepts" id="nape-core-concepts" help-id="Core-Concepts">

<section-starting-page>
<title>NAPE Core Concepts</title>
<description>
A comprehensive list of core concepts that are the first principles of NAPE.
</description>

<spotlight>
<a href="iia-three-lines-of-defense.topic" type="branch" summary="The IIA (Institute of Internal Auditors) Three Lines of Defense model describes how all relevant stakeholders from the front-line employee to the Board of Directors interact in order to ensure organizational risk mitigation.">The Three Lines of Defense</a>
<a href="installing-nape.md" type="settings" summary="todo">todo</a>
</spotlight>

<primary>
<title>todo</title>
<a href="installing-nape.md">TODO 1</a>
<a href="nape-glossary.topic">TODO 2</a>>
</primary>

<secondary>
<title>todo</title>
<a href="nape-overview.md">TODO</a>
<a href="nape-tutorials.topic">TODO</a>>
</secondary>

</section-starting-page>

</topic>
2 changes: 1 addition & 1 deletion Writerside/topics/nape-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ NAPE is a tool that helps people in the first line, second line, and third line

Keeping up with all the rules and regulations is one of the biggest challenges in regulated business. As these requirements grow, relying on old methods—like using lots of paperwork and manual labor—is no longer enough. These traditional methods don’t work well for large-scale operations, aren’t efficient, and don’t help in remembering important information over time.

The mismatch between what humans and machines are good at is a reason for this problem. Companies do not use enough of the correct technology to handle simple, repetitive tasks that computers can easily do. Instead, companies do one or both of two things. First, they only adopt technology that removes the hand-written paper and replaces these hand-written documents with digitized documents. Second, companies hire more people to execute simple evaluation tasks for which computers are best suited. This approach wastes resources and becomes even more problematic when employees leave, taking important knowledge with them.
The mismatch between what humans and machines are good at is a reason for this problem. Companies do not use enough of the correct technology to handle simple, repetitive tasks that computers can easily do. Instead, companies do one or both of two things. First, they only adopt technology that removes the handwritten paper and replaces these handwritten documents with digitized documents. Second, companies hire more people to execute simple evaluation tasks for which computers are best suited. This approach wastes resources and becomes even more problematic when employees leave, taking important knowledge with them.

Another area for improvement is a gap between the technical work needed to ensure compliance and the knowledge of the people doing the work. Often, people who don’t fully understand the compliance or regulations requirements create solutions that don’t solve the problems. On the other hand, experts who know the rules well cannot handle the technical side, which means they cannot work autonomously on these tasks.

Expand Down
2 changes: 1 addition & 1 deletion Writerside/topics/nape-usecase-and-examples.topic
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
<!-- Add several topics that are most important for this section. -->
<primary>
<title>Get started</title>
<a href="nape-core-concepts.md" summary="Learn the Core Concepts from Internal Audit and formal Assurance that NAPE is built upon.">NAPE Core Concepts</a>
<a href="nape-core-concepts.topic" summary="Learn the Core Concepts from Internal Audit and formal Assurance that NAPE is built upon.">NAPE Core Concepts</a>
<a href="installing-nape.md" summary="Install NAPE on your computer or anywhere you need it to collect evidence, evaluate facts, and report compliance.">Install NAPE</a>
</primary>

Expand Down

0 comments on commit 2d90a87

Please sign in to comment.