Skip to content

jaminwebdev/orchestratr

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

57 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Orchestatr

Welcome to Orchestatr — a structured, AI-assisted workflow for managing product documentation, feature development, and task iteration using markdown files.

This repo streamlines the product lifecycle by guiding AI-powered interactions to generate and maintain documentation, requirements, task lists, and implementation progress — all version controlled in Markdown.


Table of Contents


Project Structure

├── instructions/            # AI workflow rules (md files)
│   ├── app/                 # Instructions for building an application
│   │   ├── 01_start/        # Initial application setup instructions
│   │   └── features/        # Ongoing application feature development
│   └── site/                # Instructions for building a website
│       ├── 01_start/        # Initial website setup instructions
│       └── ...              # Ongoing website optimization and content creation
├── library_docs/            # Supporting research docs (copywriting, UX, SEO, etc.)
│   ├── copywriting/
│   ├── design_ux/
│   └── seo/
├── docs/                    # Generated documentation (product briefs, PRDs, etc.)
├── tasks/                   # Generated task lists for features and setup
├── README.md                # This file

Getting Started

This repository provides two main paths for development, each with its own set of instructions: building an application or building a website.

Building an Application

To start building a new application, navigate to the instructions/app/01_start directory and run the .md files in sequential order. These instructions will guide you through the process of creating a complete docset for your new application.

The steps include:

  1. Create a Product Brief: Define the vision, goals, and scope of your application.
  2. Market and User Analysis: Research your target market and create user personas.
  3. Feature Specifications: Detail the features and functionality of your application.
  4. Design Guidelines: Establish the visual design and user experience guidelines.
  5. Architecture: Define the technical architecture of your application.
  6. Metrics and Risks: Identify key success metrics and potential risks.
  7. MVP Tasks: Create a list of tasks for building the minimum viable product (MVP).

Building a Website

To start building a new website, navigate to the instructions/site/01_start directory and run the .md files in sequential order. These instructions will guide you through the process of creating a comprehensive plan for your new website.

The steps include:

  1. Create a Business Plan: Define the goals, target audience, and revenue model for your website.
  2. Audience Brief: Develop a detailed understanding of your target audience.
  3. Competitor Research: Analyze your competitors to identify opportunities and threats.
  4. Architecture and Content: Plan the structure of your website and the content for each page.
  5. Design and Content: Establish the visual design and write the copy for your website.
  6. Technical Plan: Define the technical requirements and implementation plan for your website.

Ongoing Development

Once you have completed the initial setup, you can use the instructions in the features and site directories for ongoing development.

Application Feature Development

For ongoing feature development for your application, use the instructions in the instructions/app/features directory:

  • create-prd.md: Generate a Product Requirements Document (PRD) for a new feature.
  • generate-tasks.md: Create a list of implementation tasks from a PRD.
  • iterate-tasks.md: Work through the tasks and mark your progress.

Website Optimization and Content Creation

For ongoing optimization and content creation for your website, use the instructions in the root of the instructions/site directory:

  • analyze-page.md: Analyze a page for UX pitfalls and get suggestions for improvement.
  • competitor-breakdown.md: Analyze a competitor's website to identify their strengths and weaknesses.
  • generate-headlines.md: Generate a list of headlines for a blog post or article.
  • iterate-tasks.md: Work through a list of tasks and mark your progress.
  • keyword-research.md: Research keywords to target for SEO.
  • new_page.md: Create a new page with a wireframe and copy in one go.
  • programmatic-seo.md: Create a plan for programmatic SEO.
  • ux-audit-leadgen.md: Audit a website for lead generation and get suggestions for improvement.

Documentation Context

Supporting research and best practices are in library_docs/:

  • copywriting/ — Copywriting guides, CTAs, headline formulas, etc.
  • design_ux/ — UX/design principles, wireframing, font pairings, etc.
  • seo/ — SEO processes, keyword research, on-page SEO, etc.

Reference these documents as needed for context and best practices.


Contributing

  • Add new .md files to instructions/ as needed.
  • Update this README and comment your rules for clarity.

License

This project is licensed under the MIT License.


Empower your team with AI-guided, structured, and maintainable product delivery workflows.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published