Example Guide

Guides lead a user through a specific task they want to accomplish, often with a sequence of steps. Writing a good guide requires thinking about what your users are trying to do.

Text can be bold, italic, or strikethrough.

Error generating PlantUML diagram: connect ECONNREFUSED 127.0.0.1:8080

@startuml
participant "Service A" as A
participant "Message Queue" as MQ
participant "Service B" as B

A -> MQ: Publish event
note right: Async message
MQ -> MQ: Store message
MQ --> A: Acknowledged

... 5 minutes later ...

B -> MQ: Poll for messages
MQ --> B: Deliver event
B -> B: Process event
B -> MQ: Acknowledge
@enduml

example.java

System.out.println();

Class Diagram Example

Error generating PlantUML diagram: connect ECONNREFUSED 127.0.0.1:8080

@startuml

skinparam classBorderThickness 3
skinparam ArrowThickness 1
skinparam defaultFontSize 16
skinparam classAttributeFontSize 18
skinparam classFontSize 16

class Vehicle {
  - vehicleId: String
  - brand: String
  - model: String
  - year: int
  + start(): void
  + stop(): void
  + getDetails(): String
}

class Car {
  - numberOfDoors: int
  - fuelType: String
  + openTrunk(): void
}

class Motorcycle {
  - hasCarrier: boolean
  + wheelie(): void
}

abstract class Engine {
  # horsepower: int
  # type: String
  + start(): void
  + stop(): void
}

class ElectricEngine {
  - batteryCapacity: int
  + charge(): void
}

class CombustionEngine {
  - fuelCapacity: double
  + refuel(): void
}

Vehicle <|-- Car
Vehicle <|-- Motorcycle
Vehicle *-- Engine
Engine <|-- ElectricEngine
Engine <|-- CombustionEngine

@enduml

Text can be **bold**, _italic_, or ~~strikethrough~~.

Further reading

• Read about how-to guides in the Diátaxis framework https://github.com/antfu