Skip to content

Commit

Permalink
Setup templates for department design docs (#230)
Browse files Browse the repository at this point in the history
Added design doc templates for department design docs
and added a description for what a department is in the department doc
  • Loading branch information
Jezithyr authored Jun 2, 2024
1 parent 810cc99 commit d83bdd4
Show file tree
Hide file tree
Showing 20 changed files with 374 additions and 58 deletions.
2 changes: 1 addition & 1 deletion src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ Space Station 14
- [Proposals]()
- [Stat Panels](en/space-station-14/user-interface/proposals/statpanels.md)
- [Departments](en/space-station-14/core-design/departments.md)
- [Departments](en/space-station-14/departments.md)
- [Atmos](en/space-station-14/departments/atmos.md)
- [PR Guidelines](en/space-station-14/departments/atmos/guidelines.md)

Expand Down
6 changes: 3 additions & 3 deletions src/en/space-station-14/accessibility.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Accessibility

```admonish warning "Attention: Placeholder!"
This section is a placeholder, pending a design-doc being created by the related work-group
```
```

# Accessibility
6 changes: 3 additions & 3 deletions src/en/space-station-14/admin-tools.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Admin Tooling

```admonish warning "Attention: Placeholder!"
This section is a placeholder, pending a design-doc being created by the related work-group
```
```

# Admin Tooling
6 changes: 3 additions & 3 deletions src/en/space-station-14/characters-species.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Character/Species

```admonish warning "Attention: Placeholder!"
This section is a placeholder, pending a design-doc being created by the related work-group
```
```

# Character/Species
6 changes: 3 additions & 3 deletions src/en/space-station-14/combat.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Combat

```admonish warning "Attention: Placeholder!"
This section is a placeholder, pending a design-doc being created by the related work-group
```
```

# Combat
1 change: 0 additions & 1 deletion src/en/space-station-14/core-design/departments.md

This file was deleted.

21 changes: 17 additions & 4 deletions src/en/space-station-14/departments.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
```admonish warning "Attention: Work in Progress!"
This section is a work in progress, additional detail will be added
```

# Departments

```admonish warning "Attention: Placeholder!"
This section is a placeholder, pending a design-doc being created by the related work-group
```
a department is a series of tubes
Departments are categories that represent a specific type of gameplay. Each department has a clear area of relevance, for example: Engineering's gameplay focuses primarily on maintenance, repair and construction while security focuses on maintaining station order and responding to threats to the station/crew.



## Gameplay Fantasy/Role

Departments have a clear "fantasy" when it comes to gameplay, for engineering this might be working as an engineer and solving practical problems related to the powergrid while for service it might be running a texas style bar on the frontiers of space, serving drinks and racking your shotgun at troublemakers.

## Department Mechanics

A department's core mechanics should reinforce/enable this fantasy while also allowing for fun interactions with other departments and players. Each department has it's own design doc complete with gameplay pillars to outline what sort of gameplay is the focus of that department.

There can be some level of overlap between game mechanics between departments (such as with medical treatments), but a department-specific mechanic should primarily be interacted with by players of that department during regular gameplay.
44 changes: 41 additions & 3 deletions src/en/space-station-14/departments/atmos.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,43 @@
# Atmos

```admonish warning "Attention: Placeholder!"
This section is a placeholder, pending a design-doc being created by the related work-group
```
```

# Atmos
The life-blood of the station

## Concept
> A high-level conceptual overview of what this department does. This is generally 1-2 paragraphs and should reflect a high level view of what this department brings to the player and the game.
## Player Story
> A short (1-2 paragraph) story from the perspective of someone playing a role in this department. This is effectively a story of the ideal experience of a player interacting with these mechanics/systems.
## Design Pillars
> A group of simple high-level ideas that embody this department. These are usually expressed with singluar words or short phrases, but may also include a *short* one sentence explaination. Game pillars are what makes the *identity* of the department.
> Pillars are there to act as guides when creating new mechanics or interactions, they serve as the measuring posts to make sure that what you are trying to do will fit in the department gameplay.
> To acheive this you want pillars that are concrete enough to get your concept across but broad enough that there is some room of interpretation and discussion.
### Pillar_1:
> Breif Pillar Description
### Pillar_2:
> Breif Pillar Description
## Objectives
> What is this department's objective when it comes to the round? Do they have a unique failure condition? If so, what is it? How does this department's objectives interact with the rest of the station?
## Progression
> How does the *gameplay* of this department change over the course of a round? Are there unlocks? Are players collecting/spending resources? Is this progression tied/related to other departments? If so how?
## Flow
> How does the *experience* of the player change over the course of a round? Are players constantly running around putting out fires or are there breaks in the action? Do players need to wait on other departments as pre-requisites for their own gameplay, or is this department fairly self-sufficent?
## Mechanics
> What major mechanics does this department use and how are they connected to this department.
### Mechanic_Placeholder1
> Each mechanic should have its own subheading and should contain a *short high-level* overview of the mechanic and how it is used by this department. Each mechanic should also link their associated design document as the subheading.
### Mechanic_Placeholder2 (Not Implemented Yet)
> Mechanics that are unimplemented should be marked with (Not Implmented Yet) and should link the associated design proposal if it exists.
45 changes: 42 additions & 3 deletions src/en/space-station-14/departments/cargo-salvage.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,44 @@
# Cargo/Salvage

```admonish warning "Attention: Placeholder!"
This section is a placeholder, pending a design-doc being created by the related work-group
```
```

# Cargo/Salvage
~~cargonia~~ shipping and receiving


## Concept
> A high-level conceptual overview of what this department does. This is generally 1-2 paragraphs and should reflect a high level view of what this department brings to the player and the game.
## Player Story
> A short (1-2 paragraph) story from the perspective of someone playing a role in this department. This is effectively a story of the ideal experience of a player interacting with these mechanics/systems.
## Design Pillars
> A group of simple high-level ideas that embody this department. These are usually expressed with singluar words or short phrases, but may also include a *short* one sentence explaination. Game pillars are what makes the *identity* of the department.
> Pillars are there to act as guides when creating new mechanics or interactions, they serve as the measuring posts to make sure that what you are trying to do will fit in the department gameplay.
> To acheive this you want pillars that are concrete enough to get your concept across but broad enough that there is some room of interpretation and discussion.
### Pillar_1:
> Breif Pillar Description
### Pillar_2:
> Breif Pillar Description
## Objectives
> What is this department's objective when it comes to the round? Do they have a unique failure condition? If so, what is it? How does this department's objectives interact with the rest of the station?
## Progression
> How does the *gameplay* of this department change over the course of a round? Are there unlocks? Are players collecting/spending resources? Is this progression tied/related to other departments? If so how?
## Flow
> How does the *experience* of the player change over the course of a round? Are players constantly running around putting out fires or are there breaks in the action? Do players need to wait on other departments as pre-requisites for their own gameplay, or is this department fairly self-sufficent?
## Mechanics
> What major mechanics does this department use and how are they connected to this department.
### Mechanic_Placeholder1
> Each mechanic should have its own subheading and should contain a *short high-level* overview of the mechanic and how it is used by this department. Each mechanic should also link their associated design document as the subheading.
### Mechanic_Placeholder2 (Not Implemented Yet)
> Mechanics that are unimplemented should be marked with (Not Implmented Yet) and should link the associated design proposal if it exists.
44 changes: 41 additions & 3 deletions src/en/space-station-14/departments/command.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,43 @@
# Command

```admonish warning "Attention: Placeholder!"
This section is a placeholder, pending a design-doc being created by the related work-group
```
```

# Command
the ~~highly incomponent~~ people in charge

## Concept
> A high-level conceptual overview of what this department does. This is generally 1-2 paragraphs and should reflect a high level view of what this department brings to the player and the game.
## Player Story
> A short (1-2 paragraph) story from the perspective of someone playing a role in this department. This is effectively a story of the ideal experience of a player interacting with these mechanics/systems.
## Design Pillars
> A group of simple high-level ideas that embody this department. These are usually expressed with singluar words or short phrases, but may also include a *short* one sentence explaination. Game pillars are what makes the *identity* of the department.
> Pillars are there to act as guides when creating new mechanics or interactions, they serve as the measuring posts to make sure that what you are trying to do will fit in the department gameplay.
> To acheive this you want pillars that are concrete enough to get your concept across but broad enough that there is some room of interpretation and discussion.
### Pillar_1:
> Breif Pillar Description
### Pillar_2:
> Breif Pillar Description
## Objectives
> What is this department's objective when it comes to the round? Do they have a unique failure condition? If so, what is it? How does this department's objectives interact with the rest of the station?
## Progression
> How does the *gameplay* of this department change over the course of a round? Are there unlocks? Are players collecting/spending resources? Is this progression tied/related to other departments? If so how?
## Flow
> How does the *experience* of the player change over the course of a round? Are players constantly running around putting out fires or are there breaks in the action? Do players need to wait on other departments as pre-requisites for their own gameplay, or is this department fairly self-sufficent?
## Mechanics
> What major mechanics does this department use and how are they connected to this department.
### Mechanic_Placeholder1
> Each mechanic should have its own subheading and should contain a *short high-level* overview of the mechanic and how it is used by this department. Each mechanic should also link their associated design document as the subheading.
### Mechanic_Placeholder2 (Not Implemented Yet)
> Mechanics that are unimplemented should be marked with (Not Implmented Yet) and should link the associated design proposal if it exists.
44 changes: 41 additions & 3 deletions src/en/space-station-14/departments/engineering.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,43 @@
# Engineering

```admonish warning "Attention: Placeholder!"
This section is a placeholder, pending a design-doc being created by the related work-group
```
```

# Engineering
The powerhouse of the ~~cell~~ station

## Concept
> A high-level conceptual overview of what this department does. This is generally 1-2 paragraphs and should reflect a high level view of what this department brings to the player and the game.
## Player Story
> A short (1-2 paragraph) story from the perspective of someone playing a role in this department. This is effectively a story of the ideal experience of a player interacting with these mechanics/systems.
## Design Pillars
> A group of simple high-level ideas that embody this department. These are usually expressed with singluar words or short phrases, but may also include a *short* one sentence explaination. Game pillars are what makes the *identity* of the department.
> Pillars are there to act as guides when creating new mechanics or interactions, they serve as the measuring posts to make sure that what you are trying to do will fit in the department gameplay.
> To acheive this you want pillars that are concrete enough to get your concept across but broad enough that there is some room of interpretation and discussion.
### Pillar_1:
> Breif Pillar Description
### Pillar_2:
> Breif Pillar Description
## Objectives
> What is this department's objective when it comes to the round? Do they have a unique failure condition? If so, what is it? How does this department's objectives interact with the rest of the station?
## Progression
> How does the *gameplay* of this department change over the course of a round? Are there unlocks? Are players collecting/spending resources? Is this progression tied/related to other departments? If so how?
## Flow
> How does the *experience* of the player change over the course of a round? Are players constantly running around putting out fires or are there breaks in the action? Do players need to wait on other departments as pre-requisites for their own gameplay, or is this department fairly self-sufficent?
## Mechanics
> What major mechanics does this department use and how are they connected to this department.
### Mechanic_Placeholder1
> Each mechanic should have its own subheading and should contain a *short high-level* overview of the mechanic and how it is used by this department. Each mechanic should also link their associated design document as the subheading.
### Mechanic_Placeholder2 (Not Implemented Yet)
> Mechanics that are unimplemented should be marked with (Not Implmented Yet) and should link the associated design proposal if it exists.
44 changes: 41 additions & 3 deletions src/en/space-station-14/departments/medical.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,43 @@
# Medical

```admonish warning "Attention: Placeholder!"
This section is a placeholder, pending a design-doc being created by the related work-group
```
```

# Medical
Responsible for causing patient's skeletons to disappear

## Concept
> A high-level conceptual overview of what this department does. This is generally 1-2 paragraphs and should reflect a high level view of what this department brings to the player and the game.
## Player Story
> A short (1-2 paragraph) story from the perspective of someone playing a role in this department. This is effectively a story of the ideal experience of a player interacting with these mechanics/systems.
## Design Pillars
> A group of simple high-level ideas that embody this department. These are usually expressed with singluar words or short phrases, but may also include a *short* one sentence explaination. Game pillars are what makes the *identity* of the department.
> Pillars are there to act as guides when creating new mechanics or interactions, they serve as the measuring posts to make sure that what you are trying to do will fit in the department gameplay.
> To acheive this you want pillars that are concrete enough to get your concept across but broad enough that there is some room of interpretation and discussion.
### Pillar_1:
> Breif Pillar Description
### Pillar_2:
> Breif Pillar Description
## Objectives
> What is this department's objective when it comes to the round? Do they have a unique failure condition? If so, what is it? How does this department's objectives interact with the rest of the station?
## Progression
> How does the *gameplay* of this department change over the course of a round? Are there unlocks? Are players collecting/spending resources? Is this progression tied/related to other departments? If so how?
## Flow
> How does the *experience* of the player change over the course of a round? Are players constantly running around putting out fires or are there breaks in the action? Do players need to wait on other departments as pre-requisites for their own gameplay, or is this department fairly self-sufficent?
## Mechanics
> What major mechanics does this department use and how are they connected to this department.
### Mechanic_Placeholder1
> Each mechanic should have its own subheading and should contain a *short high-level* overview of the mechanic and how it is used by this department. Each mechanic should also link their associated design document as the subheading.
### Mechanic_Placeholder2 (Not Implemented Yet)
> Mechanics that are unimplemented should be marked with (Not Implmented Yet) and should link the associated design proposal if it exists.
44 changes: 41 additions & 3 deletions src/en/space-station-14/departments/science.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,43 @@
# Science

```admonish warning "Attention: Placeholder!"
This section is a placeholder, pending a design-doc being created by the related work-group
```
```

# Science
THE SCIENCE TEAM

## Concept
> A high-level conceptual overview of what this department does. This is generally 1-2 paragraphs and should reflect a high level view of what this department brings to the player and the game.
## Player Story
> A short (1-2 paragraph) story from the perspective of someone playing a role in this department. This is effectively a story of the ideal experience of a player interacting with these mechanics/systems.
## Design Pillars
> A group of simple high-level ideas that embody this department. These are usually expressed with singluar words or short phrases, but may also include a *short* one sentence explaination. Game pillars are what makes the *identity* of the department.
> Pillars are there to act as guides when creating new mechanics or interactions, they serve as the measuring posts to make sure that what you are trying to do will fit in the department gameplay.
> To acheive this you want pillars that are concrete enough to get your concept across but broad enough that there is some room of interpretation and discussion.
### Pillar_1:
> Breif Pillar Description
### Pillar_2:
> Breif Pillar Description
## Objectives
> What is this department's objective when it comes to the round? Do they have a unique failure condition? If so, what is it? How does this department's objectives interact with the rest of the station?
## Progression
> How does the *gameplay* of this department change over the course of a round? Are there unlocks? Are players collecting/spending resources? Is this progression tied/related to other departments? If so how?
## Flow
> How does the *experience* of the player change over the course of a round? Are players constantly running around putting out fires or are there breaks in the action? Do players need to wait on other departments as pre-requisites for their own gameplay, or is this department fairly self-sufficent?
## Mechanics
> What major mechanics does this department use and how are they connected to this department.
### Mechanic_Placeholder1
> Each mechanic should have its own subheading and should contain a *short high-level* overview of the mechanic and how it is used by this department. Each mechanic should also link their associated design document as the subheading.
### Mechanic_Placeholder2 (Not Implemented Yet)
> Mechanics that are unimplemented should be marked with (Not Implmented Yet) and should link the associated design proposal if it exists.
Loading

0 comments on commit d83bdd4

Please sign in to comment.