OpenPrompt-Specification/prompt.onboarding.yaml at main · guided-engineering/OpenPrompt-Specification · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
$schema: .guides/schemas/prompt.schema.json
apiVersion: ops/v1
id: base.onboarding.generate
title: Generate Onboarding Guide for New Developers
persona: DocumentationEngineer
context: |
  The project includes a structured `.guides/` folder with documentation about the product, architecture, setup, testing, personas, prompts, and assessments.
  This prompt should generate a complete onboarding guide (`onboarding.md`) aimed at helping new developers understand and start contributing to the project effectively.
  The output must be written in Brazilian Portuguese, using clear, welcoming, and technically accurate language.
  Use all relevant `.guides/*` content and Git commit history to construct the guide.
category: base
difficulty: intermediate
language: english
dependencies:
  - .guides/base/
  - .guides/architecture/
  - .guides/product/
  - .guides/testing/
  - .guides/assessment/
  - .guides/personas/
  - .guides/prompts/
  - Git commit logs via `git log --format='%aN <%aE>' | sort -u`
steps:
  - id: extract-knowledge
    title: Extract documentation insights
    actions:
      - Read and integrate relevant content from `.guides/*`.
      - Summarize the purpose, architecture, and design decisions of the project.

  - id: structure-guide
    title: Structure and write onboarding guide
    actions:
      - Write a welcoming introduction with project vision and mission.
      - Create a table of contents with anchor links.
      - Describe the `.guides/` folder and the role of each section.
      - Summarize the system’s architecture and technology stack.
      - Provide local setup and development instructions.
      - Describe personas and their responsibilities.
      - Explain how to use the prompt system.
      - Document testing strategy and how to run tests.
      - Highlight automations (CI/CD, lint, validations).
      - List pending issues, TODOs, and decisions.
      - Provide contribution guidelines (branches, commits, PRs).
      - Include glossary of key terms and acronyms.
      - Append a section with contributors based on Git history.
output:
  - file: .guides/base/onboarding.md
    language: portuguese
    rules:
      - Use a clear, welcoming, and professional tone for new developers.
      - Organize content in logical chapters with anchor-linked table of contents.
      - Base all content on `.guides/*` documentation and Git logs.
      - Keep structure lean and skimmable, but comprehensive.
      - End the file with a "Contribuidores do Projeto" section with author names and emails.
tags:
  - onboarding
  - documentation
  - developer-experience
  - knowledge-transfer
  - contributors
createdBy: guided-engineering
version: 1