Tech & Data Guide

Purpose: Identify security vulnerabilities and insecure coding practices in source code

Inputs:

• Source code files or snippets
• Programming language and framework
• Security standards to apply (OWASP, CWE)
• Known vulnerability database

Task Instructions:

Analyse {source_code} written in {programming_language} using {framework}. 
Identify security vulnerabilities including SQL injection risks, XSS vulnerabilities, 
authentication flaws, data exposure issues, and insecure dependencies. Check 
against {security_standards} and classify findings by severity. Provide specific 
remediation guidance for each vulnerability found.

Outputs:

• Vulnerabilities identified with severity ratings
• CWE classifications
• Affected code locations (line numbers)
• Remediation suggestions and secure code examples
• Overall security risk score

Integration: Pre-commit hook, pull request creation, scheduled security scans, block merge if critical issues

Purpose: Provide improvement suggestions and identify issues in pull requests or code changes

Inputs:

• Code changes or diff
• Programming language and style guide
• Project context and patterns
• Review criteria checklist

Task Instructions:

Review {code_changes} in {programming_language} against {style_guide}. Analyse 
code quality, best practice compliance, performance implications, and 
maintainability. Consider project context from {project_patterns}. Check against 
{review_criteria} for documentation completeness, error handling, test coverage, 
and technical debt. Provide actionable improvement suggestions.

Outputs:

• Code quality assessment
• Best practice violations identified
• Performance and maintainability concerns
• Documentation gaps
• Specific improvement recommendations with examples

Integration: Pull request opened, code committed to review branch, post review comments, assign priority labels

Purpose: Generate comprehensive documentation from code, APIs, or system specifications

Inputs:

• Source code or API specification (OpenAPI, Swagger)
• Existing documentation to maintain consistency
• Code comments and annotations
• Target audience (developers, end users, operators)

Task Instructions:

Generate technical documentation for {code_or_spec} targeting {target_audience}. 
Create clear descriptions of functionality, parameters, return values, and usage 
examples. Follow style and formatting from {existing_documentation}. Include 
code examples, error handling guidance, and best practices. Extract information 
from {code_comments} where available.

Outputs:

• Structured documentation (functions, classes, endpoints)
• Parameter and return value descriptions
• Usage examples and code snippets
• Error codes and handling guidance
• Quick start guide

Integration: Code merge to main branch, API specification update, update documentation site, generate changelog