-
Notifications
You must be signed in to change notification settings - Fork 681
docs: restructure playbook & add AI-assisted engineering guidance #1130
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
c4e6019
8d88657
3e8e514
f15e29f
33d7718
d6866e4
56fb30a
9558b45
aee38d9
06862f9
bf286b0
eb8d26b
4492145
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -345,3 +345,6 @@ _site | |
| site/ | ||
| mkdocs/ | ||
| megalinter-reports/ | ||
|
|
||
| # Copilot agent tracking artifacts | ||
| .copilot-tracking/ | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,19 @@ | ||
| nav: | ||
| - ISE Engineering Fundamentals Playbook: README.md | ||
| - Engineering Fundamentals Checklist: engineering-fundamentals-checklist.md | ||
| - The First Week of an ISE Project: the-first-week-of-an-ise-project.md | ||
| - Start Here: start-here | ||
| - Who is ISE?: ISE.md | ||
| - Agile Development: agile-development | ||
| - Source Control: source-control | ||
| - Code Reviews: code-reviews | ||
| - Automated Testing: automated-testing | ||
| - CI/CD: CI-CD | ||
| - ... | ||
| - AI-Assisted Engineering: ai-assisted-engineering | ||
| - Security: security | ||
| - Observability: observability | ||
| - Agile Development: agile-development | ||
| - Design: design | ||
| - Developer Experience: developer-experience | ||
| - Documentation: documentation | ||
| - Engineering Feedback: engineering-feedback | ||
| - Non-Functional Requirements: non-functional-requirements | ||
| - ML & AI Projects: ml-and-ai-projects | ||
| - UI/UX: UI-UX |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,6 +9,8 @@ An engineer working for a [ISE](ISE.md) project... | |
|
|
||
| This is our playbook. All contributions are welcome! Please feel free to submit a pull request to get involved. | ||
|
|
||
| New here? Start with [How to use this playbook](start-here/README.md), then choose the guide for your role. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. how about Start Here
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. sounds good :) |
||
|
|
||
| ## Why Have a Playbook | ||
|
|
||
| * To increase overall efficiency for team members and the whole team in general. | ||
|
|
@@ -17,7 +19,9 @@ This is our playbook. All contributions are welcome! Please feel free to submit | |
|
|
||
| If you do nothing else follow the [Engineering Fundamentals Checklist](./engineering-fundamentals-checklist.md)! | ||
|
|
||
| The [first week of an ISE project](./the-first-week-of-an-ise-project.md) is a breakdown of the sections of the playbook according to the structure of an Agile sprint. | ||
| The [project kickoff checklist](./start-here/project-kickoff-checklist.md) is a breakdown of the sections of the playbook according to the structure of an Agile sprint. | ||
|
|
||
| Use [AI-Assisted Engineering](./ai-assisted-engineering/README.md) as the shared baseline for using AI tools in engineering work while preserving human ownership, validation, security, privacy, accessibility, and project governance. | ||
|
|
||
| ## General Guidance | ||
|
|
||
|
|
||

Uh oh!
There was an error while loading. Please reload this page.