### Create Expandable Link with Nutshell
Source: https://docs.arc42.org/examples/deployment-htmlsc-1
This snippet demonstrates how to create an expandable link using Nutshell by ensuring the link text starts with a colon. This tells Nutshell to process the link.
```HTML
:Link Text
```
--------------------------------
### Nutshell Integration for Expandable Links
Source: https://docs.arc42.org/examples/runtime-mama-2
This snippet provides instructions on how to integrate Nutshell into a website to create expandable links. It involves copying code to the site's head and formatting links with a leading colon.
```HTML
Step 1) Copy this code into the of your site:
Step 2) In your article, create a link to and make sure the link text starts with a :colon, :like this, so Nutshell knows to make it expandable.
Step 3) That's all, folks! 🎉
learn more about Nutshell
```
--------------------------------
### Nutshell Integration for Expandable Links
Source: https://docs.arc42.org/examples/solution-strategy-mama-2
This snippet provides instructions on how to integrate Nutshell into a website to create expandable links. It involves adding a script to the HTML head and formatting link text with a leading colon.
```html
Step 1) Copy this code into the of your site:
Step 2) In your article, create a link to and make sure the link text starts with a :colon, :like this, so Nutshell knows to make it expandable.
Step 3) That's all, folks!
learn more about Nutshell
```
--------------------------------
### Documenting Concepts with Source Code
Source: https://docs.arc42.org/section-8
This tip emphasizes the value of including source code examples when documenting concepts. It suggests that demonstrating how a concept is implemented in practice makes the documentation more concrete and understandable.
```General
#concept
#source-code
#example
#test
```
--------------------------------
### Nutshell Integration for Expandable Links
Source: https://docs.arc42.org/examples/deployment-1
This snippet provides instructions on how to integrate Nutshell into a website to create expandable links. It involves adding a script to the HTML head and formatting links with a leading colon.
```html
```
```html
:Link Text
```
--------------------------------
### Document Software/Hardware Mapping with UML Deployment Diagrams
Source: https://docs.arc42.org/keywords
This tip suggests using UML deployment diagrams to visually represent the mapping of software components to hardware infrastructure. This aids in understanding the physical deployment of the system.
```UML
@startuml
' Example UML Deployment Diagram
node "Server" {
component "Application Server"
component "Database Server"
}
node "Client"
"Client" -- "Application Server"
"Application Server" -- "Database Server"
@enduml
```
--------------------------------
### Create Expandable Nutshell Links
Source: https://docs.arc42.org/tips/2-1
This snippet demonstrates how to create a link that Nutshell will recognize and make expandable. The link text must start with a colon.
```html
:Link Text
```
--------------------------------
### Create Expandable Links with Nutshell
Source: https://docs.arc42.org/tips/9-6
This example demonstrates how to create a link that Nutshell will recognize as expandable. The link text must start with a colon (:) for Nutshell to process it correctly.
```html
:Link Text
```
--------------------------------
### Nutshell - Link Integration
Source: https://docs.arc42.org/tips/7-7
Instructions on how to integrate Nutshell functionality into a website. This involves copying code to the site's head and creating specific link formats in articles.
```html
:Link Text
```
--------------------------------
### Describe Solution Approaches as a Table
Source: https://docs.arc42.org/keywords
This tip suggests presenting solution approaches in a tabular format for clarity and conciseness. Tables allow for easy comparison and understanding of different options.
```General
Tip 4-2: Describe the solution approaches as a table!
```
--------------------------------
### Implement Nutshell Expandable Links
Source: https://docs.arc42.org/tips/6-1
This snippet demonstrates how to integrate Nutshell's functionality into a website. It involves adding a script to the site's head and creating specific link formats within articles to enable expandable content.
```html
```
```html
:Link Text
// Ensure link text starts with a colon for Nutshell to recognize it.
```
--------------------------------
### Java Unit Test for Interface Documentation (joptsimple)
Source: https://docs.arc42.org/tips/5-22
This Java unit test demonstrates using the joptsimple library to parse command-line options. It serves as an example of how unit tests can document interface behavior, specifying prerequisites (OptionParser setup), usage context (parsing options), and expected outcomes (assertions on option presence).
```Java
package joptsimple.examples;
import joptsimple.OptionParser;
import joptsimple.OptionSet;
import org.junit.Test;
import static org.junit.Assert.*;
public class ShortOptionsTest {
@Test
public void supportsShortOptions() {
OptionParser parser = new OptionParser( "aB?*." );
OptionSet options = parser.parse( "-a", "-B", "-?" );
assertTrue( options.has( "a" ) );
assertTrue( options.has( "B" ) );
assertTrue( options.has( "?" ) );
assertFalse( options.has( "." ) );
}
}
```
--------------------------------
### Specify Interfaces with Runtime Scenarios
Source: https://docs.arc42.org/keywords
This tip recommends documenting or specifying software interfaces using runtime scenarios. By illustrating how an interface behaves in different operational contexts and interactions, it provides a practical understanding of its usage and expected outcomes. This is valuable for understanding the dynamic aspects of interface interactions.
```General
Tip 5-23: Document or specify interfaces with runtime scenarios!
```
--------------------------------
### Create Expandable Link with Nutshell
Source: https://docs.arc42.org/tips/3-1
This snippet demonstrates how to create an expandable link using Nutshell by ensuring the link text starts with a colon.
```html
:Link Text
```
--------------------------------
### Documenting Hardware and Infrastructure
Source: https://docs.arc42.org/keywords
This section focuses on documenting the technical infrastructure, including hardware and deployment environments. It suggests explaining hardware decisions, mapping building blocks to hardware, and detailing nodes and operational aspects.
```Markdown
## deployment-view
* Tip 7-1: Document your technical infrastructure (hardware)!
* Tip 7-2: Explain hardware and infrastructure decisions!
* Tip 7-3: Document the various environments!
* Tip 7-4: Document the deployment view hierarchically!
* Tip 7-5: Document the mapping of building-blocks to hardware!
* Tip 7-7: Use tables to document software/hardware mapping!!
* Tip 7-8: Explain your nodes!
* Tip 7-9: Explain what (else) is relevant for productive use (aka operation) of the system)!
* Tip 7-10: Leave hardware decisions to hardware-experts!
```
--------------------------------
### Integrate Nutshell Script
Source: https://docs.arc42.org/tips/2-1
This snippet shows the code to be placed in the section of an HTML document to enable Nutshell's features. It assumes Nutshell is a JavaScript library or service.
```html
```
--------------------------------
### Implement Nutshell Expandable Links
Source: https://docs.arc42.org/tips/5-9
This snippet demonstrates how to integrate Nutshell's functionality into a website. It involves adding a script to the `` section and creating specific link formats within the article content to enable expandable text.
```html
Step 1) Copy this code into the of your site:
Step 2) In your article, create a link to and make sure the link text starts with a :colon, :like this, so Nutshell knows to make it expandable.
Step 3) That's all, folks! 🎉
```
--------------------------------
### Nutshell CSS Integration
Source: https://docs.arc42.org/examples
Instructions for integrating Nutshell, a tool for creating expandable content, into a website. This involves adding a script to the HTML head and formatting links with a colon prefix.
```html
```
```html
:Link Text
```
--------------------------------
### Nutshell Integration for Expandable Links
Source: https://docs.arc42.org/tips/5-21
This snippet provides instructions for integrating Nutshell, a tool that makes links expandable. It involves copying code into the site's `` and formatting links with a leading colon to activate the expandable feature.
```HTML
Step 1) Copy this code into the of your site:
Step 2) In your article, create a link to and make sure the link text starts with a :colon, :like this, so Nutshell knows to make it expandable.
Step 3) That's all, folks! 🎉
learn more about Nutshell
```
--------------------------------
### Nutshell Link Implementation
Source: https://docs.arc42.org/tips/7-1
This demonstrates how to create an expandable link using the Nutshell functionality. The link text must start with a colon (:) for Nutshell to recognize and process it.
```html
:Link Text
```
--------------------------------
### Show System Context and External Interfaces
Source: https://docs.arc42.org/keywords
This set of tips focuses on defining and visualizing the system's context and its external interfaces. It's important to clearly demarcate the system's boundaries and represent its environment, often using diagrams. Simplifying the context through categorization and ensuring consistency between external interfaces and the system's internal structure (like Level-1 building blocks) are key practices. Analyzing interfaces for risks and considering quality requirements at these boundaries are also highlighted.
```General
Tip 3-1: Explicitly demarcate your system from its environment!
```
```General
Tip 3-2: Show the context as diagram!
```
```General
Tip 3-6: Simplify the context by categorization!
```
```General
Tip 3-9: Show all (all!) external interfaces!
```
```General
Tip 5-4: Ensure consistency of external interfaces to level-1
```
```General
Tip 11-2: Analyze (external) interfaces for problems and risks!
```
```General
Tip 3-14: Pay attention to quality requirements at external interfaces!
```
--------------------------------
### Nutshell Link Activation
Source: https://docs.arc42.org/tips/1-12
Demonstrates the required format for creating expandable links using Nutshell. The link text must start with a colon to trigger the Nutshell functionality.
```html
:Link Text
```
--------------------------------
### Create Expandable Link with Nutshell
Source: https://docs.arc42.org/tips/9-8
This example demonstrates how to create an expandable link using Nutshell. By prefixing the link text with a colon, Nutshell recognizes it and makes the link expandable within the article.
```HTML
:Link Text
```
--------------------------------
### Documenting Deployment Views with UML
Source: https://docs.arc42.org/keywords
This section details how to document the deployment view of a system, focusing on the mapping of building blocks to hardware. It suggests using UML deployment diagrams and tables for clarity, and explaining nodes and operational requirements.
```UML
## deployment-view
* Tip 7-6: Use UML deployment diagrams to document software/hardware mapping!
```
--------------------------------
### Map Runtime Scenarios to Building Blocks
Source: https://docs.arc42.org/keywords
This tip emphasizes the importance of linking runtime scenarios with the system's building blocks. It suggests documenting how existing building blocks are utilized within different runtime scenarios. Furthermore, it recommends focusing documentation efforts on a few key runtime scenarios to maintain clarity and conciseness.
```General
Tip 6-1: Always map existing building blocks to the activities within runtime scenarios!
```
```General
Tip 6-2: Document only a few runtime scenarios!
```
--------------------------------
### Add Nutshell CSS and JS to HTML Head
Source: https://docs.arc42.org/examples/deployment-htmlsc-1
This snippet shows how to include the necessary Nutshell CSS and JavaScript files in the section of an HTML document to enable its features.
```HTML
```
--------------------------------
### Implement Expandable Links with Nutshell
Source: https://docs.arc42.org/tips/6-2
This snippet demonstrates how to implement expandable links using the Nutshell library. It involves adding a script to the HTML head and formatting links with a leading colon to activate the functionality.
```html
```
```html
:Expandable Link Text
```
--------------------------------
### Nutshell CSS for Expandable Links
Source: https://docs.arc42.org/tips/3-2
This snippet provides the necessary CSS to be included in the `` of a website to enable the Nutshell expandable link functionality. It ensures that links starting with a colon are rendered as expandable elements.
```html
```
--------------------------------
### PlantUML Data Model Diagram
Source: https://docs.arc42.org/tips/8-7
This PlantUML code defines a data model for a system, including entities such as Person, Hospital, Staff, and their relationships. It serves as an example for documenting fundamental data structures.
```PlantUML
@startuml
interface Person {
title: String
lastName: String
firstname: String
birthData: Date
gender: Gender
postalAddress: Address
}
Person "1" -left- "1..*" Phone
Person <|-- Patient
Person <|-- Staff
Person "*" --right-- "*" Hospital
class Hospital {
name: String
address: Address
}
class Department {
name: String
location: String
}
Department "*" -down-* "1" Hospital
Department "1" -- "1..*" Staff
(Department, Staff) -- Contract
Hospital --- "1..*" Phone
class Phone {
telNr: String
isPrivat: Boolean
}
class Staff {
joined: Date
education: String[]
certificate: String[]
languages: String[]
}
class Contract{
begin: Date
isUnlimited: Boolean
monthSalary: Float
contractType: ContractType
}
class Patient {
id: String {id}
name: String
aufgenommen: Date
allergie: String[]
aktuelleDiagnose: Diagnosis[]
}
Staff <|-down- MedicalStaff
Staff <|-down- AdministrativeStaff
Staff <|-down- TechnicalStaff
class MedicalStaff{
fachrichtung: String[]
approbation: Boolean
}
MedicalStaff -left- Patient
class AdministrativeStaff {
}
class TechnicalStaff {
}
@enduml
```