Skip to content

This playbook provides guidance on best practices for integrating AI into the Software Development Lifecycle (SDLC), specifically tailored to Zuhlke's needs and challenges.

License

Notifications You must be signed in to change notification settings

kevinlin/ai-sdlc-playbook

Repository files navigation

AI SDLC Playbook

A comprehensive guide for integrating AI tools and practices into the Software Development Lifecycle (SDLC), specifically designed for development teams looking to enhance their productivity and code quality through AI assistance.

About

This playbook provides practical guidance, rules, workflows, and prompts for effectively using AI-powered IDEs like Cursor, Kiro, and other AI development assistants. It's tailored for teams who want to adopt AI-driven development practices while maintaining high standards of code quality, security, and maintainability.

Target Audience: Software developers, development teams, technical leads, and organizations looking to integrate AI into their development workflow.

Quick Start

  1. Browse the Documentation: Visit the complete documentation for detailed guidance
  2. Choose Your Focus Area:
  3. Follow the Workflow: Implement the AI Development Workflow in your projects

What's Included

  • IDE Rules - Rules and guidelines for AI-powered IDEs to improve AI assistance
  • MCP Server - Model Control Protocol server resources for enhanced AI capabilities
  • AI Development Workflow - Step-by-step workflow for AI-assisted development
  • Prompt Library - Curated collection of effective AI prompts for development tasks

Usage Examples

Live Documentation

The complete documentation is available at: https://kevinlin.github.io/ai-sdlc-playbook

Contributing

We welcome contributions! Please:

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes following our Markdown Guidelines
  4. Submit a pull request

For major changes, please open an issue first to discuss what you would like to change.

📄 License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Attribution: Large sections of this playbook were adapted from the DEFRA AI SDLC Playbook © Crown copyright (2023) Department for Environment, Food & Rural Affairs, originally released under the Open Government Licence v3.0.

Additional content and inspiration drawn from the Kiro spec-driven development guide by Jason Kneen, which provides comprehensive system prompts and methodologies for AI-assisted development with Kiro IDE by Amazon.


🔧 Development & Site Publishing

Setting up Python Virtual Environment

python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

Local Development

Start a local development server:

mkdocs serve --dev-addr=0.0.0.0:8000

Building the Site

Build the static site:

mkdocs build

GitHub Actions Deployment

This repository includes a GitHub Actions workflow that automatically builds and deploys the site to GitHub Pages when:

  • Changes are pushed to the main branch
  • The workflow is manually triggered from the Actions tab

The workflow configuration is located in .github/workflows/publish.yml and uses GitHub's official Pages deployment actions with the following steps:

  1. Checkout the source code
  2. Set up Python environment
  3. Install dependencies and build the site
  4. Upload the generated files as an artifact
  5. Deploy to GitHub Pages

To manually trigger a deployment, go to the Actions tab in the GitHub repository and run the "Build & Publish site to GitHub Pages" workflow.

About

This playbook provides guidance on best practices for integrating AI into the Software Development Lifecycle (SDLC), specifically tailored to Zuhlke's needs and challenges.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •