stream-coding

What it does

Stream Coding facilitates a documentation-first software development approach. It aims to generate code automatically based on comprehensive and well-defined documentation. This methodology prioritizes creating clear and detailed documentation, which then serves as the blueprint for AI-powered code generation.

When to use it

• New Project Initialization: Ideal for starting new projects where a strong foundation of documentation is desired from the outset.
• Refactoring Legacy Code: Use to rebuild or modernize existing systems by first documenting their current functionality and then generating updated code.
• Automated Feature Implementation: When implementing new features, prioritize detailed documentation before attempting automated code generation.
• Standardizing Development Practices: Stream Coding can help enforce consistent coding standards through the creation of reusable documentation templates.

Key capabilities

• Documentation-first development
• Automatic code generation from documentation
• Triggers on "Build", "Create", "Implement", and "Document" actions.
• AI-ready documentation output

Example prompts

• “Generate code for a function that calculates the factorial of a given number, based on this documentation: [paste documentation here].”
• “Implement the ‘User Authentication’ feature as described in the attached document.”
• “Build a class representing a 'Product' with attributes and methods detailed in the following specification: [paste documentation here]."

Tips & gotchas

The quality of the generated code is directly dependent on the clarity and completeness of the provided documentation. Ensure your documentation adheres to a consistent structure and includes all necessary details before attempting code generation.