neudesic / engineering-playbook

This is the playbook for client engagements, as well as internal projects. The goal is to establish a baseline for technical excellence so that Neudesic can return to engineering dominance.

Neudesic Engineering Excellence Playbook

An engineer or data scientist working on an NEE project...

• Has responsibilities to their team – mentor, coach, and lead.
• Knows their playbook. Follows their playbook. Fixes their playbook if it is broken. If they find a better playbook, they copy it. If somebody could use your playbook, give them yours.
• Leads by example. Models the behaviors we desire both interpersonally and technically.
• Strives to understand how their work fits into a broader context and ensures the outcome.

This is our playbook. All contributions welcome! Please feel free to submit a pull request to get involved.

Note: If you are reading this on GitHub - head over to https://neudesic.github.io/engineering-playbook/ for a better reading experience

Why Have A Playbook

• To increase overall efficiency for team members and the whole team in general.
• Reduce the number of mistakes and avoid common pitfalls.
• Strive to be a better engineer and learn from other people's shared experience.

"The" Checklist

If you do nothing else follow the Engineering Fundamentals Checklist! It's here to help follow the Engineering Fundamentals.

Structure of a Sprint

A breakdown of sections according to the structure of an Agile sprint.

General Guidance

• Keep the code quality bar high.
• Value quality and precision over ‘getting things done’.
• Work diligently on the one important thing.
• As a distributed team take time to share context via wiki, teams and backlog items.
• Make the simple thing work now. Build fewer features today, but ensure they work amazingly. Then add more features tomorrow.
• Avoid adding scope to a backlog item, instead add a new backlog item.
• Our goal is to ship incremental customer value.
• Keep backlog item details up to date to communicate the state of things with the rest of your team.
• Report product issues found and provide clear and repeatable engineering feedback!
• We all own our code and each one of us has an obligation to make all parts of the solution great.

QuickLinks

• Engineering Fundamentals Checklist
• Structure of a Sprint

Engineering Fundamentals

• Accessibility
• Agile Development
• Automated Testing
• Code Reviews
• Continuous Delivery (CD)
• Continuous Integration (CI)
• Design
• Developer Experience
• Documentation
• Engineering Feedback
• Observability
• Security
• Privacy
• Source Control
• Reliability

Fundamentals for Specific Technology Areas

• Machine Learning Fundamentals
• User-Interface Engineering

Contributing

See CONTRIBUTING.md for contribution guidelines.

engineering-playbook's Issues

Create our own API guidance

What

We need API guidance, including REST, GraphQL, gRPC, and other patterns. This guidance should include API management, versioning, security, and API First.

AI and ML Review

We need alignment in the playbook for the AI R&D team and the Responsible AI initiative.

https://neudesic.github.io/engineering-playbook/machine-learning/

Fix CODEOWNERS for Neudesic maintainers

The current CODEOWNERS file references Microsoft ISE members as a result of the fork. The Neudesic fork should have separate maintainers.

The CODEOWNERS should be @chadcook @skyarkitekten @cloudappsguy @arcware @jeffblankenburg @mikeholdorf

Add The Method Training Material to Engineering Excellence / System Design & Architecture

I would like to add PowerPoint presentation, recoding and references to Righting Software https://rightingsoftware.org/ to Engineering Playbook under the folder Engineering Excellence / System Design & Architecture.

Please let me know which direction I should choose.

Change 'dev crew' to dev team or engineering team

The playbook makes references to "dev crew" throughout. This is MSFT lexicon and should be replaced. Same for CSE.

• Dev Crew replace
• CSE replace

Neudesic Branding

When this site publishes to GitHub Pages, it should have a "Neudesic" look and feel.

Fix Additional Branding

Some pages still have links to Microsoft and reference the ISE.

Inner Source Code of Conduct

The Engineering Playbook references a code of conduct that does not currently exist. Other inner source repos should also follow this code of conduct.

Tasks

Beta Give feedback

1. Code of Conduct Approved
2. Code of Conduct published to .github for the Neudesic Org

Microsoft Acknowledgement

Microsoft ISE team built this and we want to thank them and acknowledge their influence on our thinking.

Create an introduction to Code Reviews explaining how to make the best of a code review

Is your feature request related to a problem? Please describe.
Code Reviews is something we need to conduct as a part of our practices as high-quality delivery organization. Not all code contributors (regardless of practice) understand code reviews, how to approach them, and their true purpose.

Describe the solution you'd like
Write a brief introduction with additional supporting content on how to achieve effective code reviews.

Describe alternatives you've considered
Alternative approaches may eventually include a video series for alternate learning styles, including placement of 'code review' training in 360 Learning.

Additional context
None

Create Developer Productivity Guidance

Currently, our consultants do not have guidance on how to apply developer productivity. This includes processess and tooll recommendations.

We need guidance on how to apply Developer Productivity on every project.

Tasks

Beta Give feedback

No tasks being tracked yet.