-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
13 changed files
with
1,439 additions
and
191 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -31,12 +31,24 @@ workspace/ | |
│ └── files/ | ||
│ └── diagram.png # Can be referenced in markdown content | ||
└── Project Alpha.yaml # Project configuration | ||
├── QMS Documents/ # QMS documentation | ||
│ ├── [SOP-001] Document Control.md # Document template | ||
│ ├── [SOP-001] Document Control/ # Template implementations | ||
│ │ └── [SOP-002] Document Review.md # Controlled document | ||
│ └── [WI-001] Document Template Usage.md # Standalone controlled document | ||
└── QMS Documents.yaml # QMS space configuration | ||
``` | ||
|
||
### File Format Requirements | ||
* All spaces files must be in YAML format | ||
* All document/issue files must include YAML frontmatter followed by Markdown content | ||
* Children documents/issues are located in the folder with the same name as the parent document/issue | ||
|
||
#### Space Configuration (*.yaml) | ||
Project space (`Project Alpha.yaml`): | ||
|
||
#### Tracker Issues | ||
|
||
##### 1. Project Configuration (*.yaml) | ||
Example: `Project Alpha.yaml`: | ||
```yaml | ||
class: tracker:class:Project # Required | ||
title: Project Alpha # Required | ||
|
@@ -51,32 +63,8 @@ description: string # Optional | |
defaultIssueStatus: Todo # Optional | ||
``` | ||
Teamspace (`Documentation.yaml`): | ||
```yaml | ||
class: document:class:Teamspace # Required | ||
title: Documentation # Required | ||
private: false # Optional, default: false | ||
autoJoin: true # Optional, default: true | ||
owners: # Optional, list of email addresses | ||
- [email protected] | ||
members: # Optional, list of email addresses | ||
- [email protected] | ||
description: string # Optional | ||
``` | ||
|
||
#### Documents and Issues (*.md) | ||
All files must include YAML frontmatter followed by Markdown content: | ||
|
||
Document (`Getting Started.md`): | ||
```yaml | ||
--- | ||
class: document:class:Document # Required | ||
title: Getting Started Guide # Required | ||
--- | ||
# Content in Markdown format | ||
``` | ||
|
||
Issue (`1.Project Setup.md`): | ||
##### 2. Issue (*.md) | ||
Example: `1.Project Setup.md`: | ||
```yaml | ||
--- | ||
class: tracker:class:Issue # Required | ||
|
@@ -90,11 +78,11 @@ remainingTime: 4 # Optional, in hours | |
Task description in Markdown... | ||
``` | ||
|
||
### Task Identification | ||
* Human-readable task ID is formed by combining project's identifier and task number from filename | ||
* Example: For project with identifier "ALPHA" and task "1.Setup Project.md", the task ID will be "ALPHA-1" | ||
##### Issue Identification | ||
* Human-readable issue ID is formed by combining project's identifier and issue number from filename | ||
* Example: For project with identifier `ALPHA` and issue `1.Setup Project.md`, the issue ID will be `ALPHA-1` | ||
|
||
### Allowed Values | ||
##### Allowed Values | ||
|
||
Issue status values: | ||
* `Backlog` | ||
|
@@ -109,6 +97,99 @@ Issue priority values: | |
* `High` | ||
* `Urgent` | ||
|
||
#### Documents | ||
|
||
##### 1. Teamspace Configuration (*.yaml) | ||
Example: `Documentation.yaml`: | ||
```yaml | ||
class: document:class:Teamspace # Required | ||
title: Documentation # Required | ||
private: false # Optional, default: false | ||
autoJoin: true # Optional, default: true | ||
owners: # Optional, list of email addresses | ||
- [email protected] | ||
members: # Optional, list of email addresses | ||
- [email protected] | ||
description: string # Optional | ||
``` | ||
|
||
##### 2. Document (*.md) | ||
Example: `Getting Started.md`: | ||
```yaml | ||
--- | ||
class: document:class:Document # Required | ||
title: Getting Started Guide # Required | ||
--- | ||
# Content in Markdown format | ||
``` | ||
|
||
#### Controlled Documents | ||
##### 1. Space Configuration (*.yaml) | ||
QMS Document Space: `QMS Documents.yaml`: | ||
```yaml | ||
class: documents:class:OrgSpace # Required | ||
title: QMS Documents # Required | ||
private: false # Optional, default: false | ||
owners: # Optional, list of email addresses | ||
- [email protected] | ||
members: # Optional, list of email addresses | ||
- [email protected] | ||
description: string # Optional | ||
qualified: [email protected] # Optional, qualified user | ||
manager: [email protected] # Optional, QMS manager | ||
qara: [email protected] # Optional, QA/RA specialist | ||
``` | ||
|
||
##### 2. Document Template (*.md) | ||
Example: `[SOP-001] Document Control.md`: | ||
```yaml | ||
--- | ||
class: documents:mixin:DocumentTemplate # Required | ||
title: SOP Template # Required | ||
docPrefix: SOP # Required, document code prefix | ||
category: documents:category:Procedures # Required | ||
author: John Smith # Required | ||
owner: Jane Wilson # Required | ||
abstract: Template description # Optional | ||
reviewers: # Optional | ||
- [email protected] | ||
approvers: # Optional | ||
- [email protected] | ||
coAuthors: # Optional | ||
- [email protected] | ||
--- | ||
Template content in Markdown... | ||
``` | ||
|
||
##### 3. Controlled Document (*.md) | ||
Example: `[SOP-002] Document Review.md`: | ||
```yaml | ||
--- | ||
class: documents:class:ControlledDocument # Required | ||
title: Document Review Procedure # Required | ||
template: [SOP-001] Document Control.md # Required, path to template | ||
author: John Smith # Required | ||
owner: Jane Wilson # Required | ||
abstract: Document description # Optional | ||
reviewers: # Optional | ||
- [email protected] | ||
approvers: # Optional | ||
- [email protected] | ||
coAuthors: # Optional | ||
- [email protected] | ||
changeControl: # Optional | ||
description: Initial document creation | ||
reason: Need for standardized process | ||
impact: Improved document control | ||
--- | ||
Document content in Markdown... | ||
``` | ||
##### Controlled Document Code Format | ||
* Document code must be specified in file name: `[CODE] Any File Name.md` | ||
* If code is not specified for controlled document, it will be generated automatically using template's docPrefix and sequential number (e.g. `SOP-99`) | ||
* If code is not specified for template, it will be generated automatically as `TMPL-seqNumber`, where `seqNumber` is the sequence number of the template in the space | ||
|
||
|
||
### Run Import Tool | ||
```bash | ||
docker run \ | ||
|
@@ -125,3 +206,6 @@ docker run \ | |
* All users must exist in the system before import | ||
* Assignees are mapped by full name | ||
* Files in space directories can be used as attachments when referenced in markdown content | ||
* Document codes (in square brackets) must be unique across all document spaces | ||
* Controlled documents must be created in the same space as their templates | ||
* Controlled documents can be imported only with `Draft` status |
11 changes: 11 additions & 0 deletions
11
dev/import-tool/docs/huly/example-workspace/QMS Documents.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
class: documents:class:OrgSpace | ||
title: QMS Documents | ||
description: Quality Management System Documentation | ||
private: false | ||
owners: | ||
- [email protected] | ||
members: | ||
- [email protected] | ||
qualified: [email protected] | ||
manager: [email protected] | ||
qara: [email protected] |
33 changes: 33 additions & 0 deletions
33
...rt-tool/docs/huly/example-workspace/QMS Documents/[SOP-001] Document Control.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
--- | ||
class: documents:mixin:DocumentTemplate | ||
title: 'Standard Operating Procedure Template' | ||
docPrefix: SOP | ||
category: documents:category:Procedures | ||
author: Joe Shmoe | ||
owner: John Doe | ||
abstract: Template for Standard Operating Procedures | ||
reviewers: | ||
- John Doe | ||
- Joe Shmoe | ||
approvers: | ||
- Joe Shmoe | ||
--- | ||
# Standard Operating Procedure | ||
|
||
## 1. Purpose | ||
[Describe the purpose of the procedure] | ||
|
||
## 2. Scope | ||
[Define the scope and applicability] | ||
|
||
## 3. Responsibilities | ||
[List key roles and responsibilities] | ||
|
||
## 4. Procedure | ||
[Detail the step-by-step procedure] | ||
|
||
## 5. References | ||
[List related documents] | ||
|
||
## 6. Revision History | ||
[Document revision history] |
43 changes: 43 additions & 0 deletions
43
...workspace/QMS Documents/[SOP-001] Document Control/[SOP-002] Document Review.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
--- | ||
class: documents:class:ControlledDocument | ||
title: Document Review Procedure | ||
template: '../[SOP-001] Document Control.md' | ||
author: Joe Shmoe | ||
owner: John Doe | ||
abstract: Procedure for document review and approval process | ||
reviewers: | ||
- John Doe | ||
- Joe Shmoe | ||
approvers: | ||
- Joe Shmoe | ||
changeControl: | ||
description: Initial document creation | ||
reason: Need for standardized review process | ||
impact: Improved document quality control | ||
--- | ||
# Document Review Procedure | ||
|
||
## 1. Purpose | ||
This procedure defines the process for reviewing quality management system documents. | ||
|
||
## 2. Scope | ||
Applies to all controlled documents within the QMS. | ||
|
||
## 3. Responsibilities | ||
- Document Owner: Responsible for content | ||
- Reviewers: Technical review | ||
- QA Manager: Final approval | ||
|
||
## 4. Procedure | ||
1. Author prepares document | ||
2. Technical review | ||
3. QA review | ||
4. Final approval | ||
5. Document release | ||
|
||
## 5. References | ||
- Quality Manual | ||
- Document Control Procedure | ||
|
||
## 6. Revision History | ||
Rev 0.1 - Initial draft |
29 changes: 29 additions & 0 deletions
29
...l/docs/huly/example-workspace/QMS Documents/[WI-001] Document Template Usage.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
class: documents:class:ControlledDocument | ||
title: Document Template Usage Guide | ||
template: '[SOP-001] Document Control.md' | ||
author: Joe Shmoe | ||
owner: John Doe | ||
abstract: Work instruction for using document templates | ||
reviewers: | ||
- John Doe | ||
- Joe Shmoe | ||
approvers: | ||
- Joe Shmoe | ||
--- | ||
# Document Template Usage Guide | ||
|
||
## 1. Purpose | ||
Guide users in proper usage of QMS document templates. | ||
|
||
## 2. Scope | ||
All personnel creating QMS documentation. | ||
|
||
## 3. Procedure | ||
1. Select appropriate template | ||
2. Fill in required sections | ||
3. Submit for review | ||
|
||
## 4. References | ||
- [Document Control SOP](./[SOP-001]%20Document%20Control.md) | ||
- [Document Review Procedure](./[SOP-001]%20Document%20Control/[SOP-002]%20Document%20Review.md) |
Oops, something went wrong.