FSSCoding
a08e2b4001
- Created 15 real-world test scenarios across diverse industries - Each scenario includes autonomous instructions and results placeholders - Industries covered: engineering, healthcare, finance, education, tech, agriculture - Scenarios test FSS-Mini-RAG with authentic professional use cases - Complete deployment guide and validation tools included - Ready for agent delegation and execution Scenarios range from mechanical engineering CAD standards to cybersecurity compliance, ensuring broad market validation.
66 lines
3.0 KiB
Markdown
66 lines
3.0 KiB
Markdown
# Test Scenario 14: Software Development - API Design & Documentation Best Practices
|
|
|
|
## 🏢 **Industry Context**: Software Development/Tech
|
|
**Role**: Technical Lead
|
|
**Task**: Research API design patterns and documentation strategies for microservices architecture
|
|
|
|
## 📋 **Scenario Description**
|
|
You're leading the development of a microservices platform for a SaaS company. You need to research REST API design best practices, OpenAPI documentation standards, authentication patterns, and testing strategies to ensure scalable and maintainable system architecture.
|
|
|
|
## 🎯 **Your Mission (Completely Autonomous)**
|
|
|
|
### **Step 1: Setup FSS-Mini-RAG**
|
|
1. Read the repository README.md to understand how to install FSS-Mini-RAG
|
|
2. Follow the installation instructions for your platform
|
|
3. Verify the installation works by running `rag-mini --help`
|
|
|
|
### **Step 2: Gather Research Materials**
|
|
Create a folder called `api-design-research` and populate it with relevant documentation:
|
|
- REST API design principles and best practices
|
|
- OpenAPI specification and documentation standards
|
|
- API authentication and security patterns
|
|
- Microservices architecture design guidelines
|
|
- API testing and monitoring strategies
|
|
|
|
**Sources to explore**:
|
|
- API design and development best practices guides
|
|
- OpenAPI and Swagger documentation resources
|
|
- Microservices architecture patterns and case studies
|
|
- API security and authentication frameworks
|
|
- Software testing and quality assurance resources
|
|
|
|
### **Step 3: Index and Search**
|
|
1. Use FSS-Mini-RAG to index your `api-design-research` folder
|
|
2. Perform searches to answer these questions:
|
|
- "What are the REST API design principles for scalable systems?"
|
|
- "How should API documentation be structured using OpenAPI?"
|
|
- "What authentication patterns work best for microservices?"
|
|
- "How should API versioning be managed?"
|
|
- "What testing strategies ensure API reliability?"
|
|
|
|
### **Step 4: Document Your Findings**
|
|
Write your findings in `RESULTS.md` including:
|
|
- API design patterns and architectural principles
|
|
- Documentation standards and tooling recommendations
|
|
- Security and authentication implementation strategies
|
|
- Version management and backward compatibility
|
|
- Testing and monitoring framework recommendations
|
|
|
|
### **Step 5: Evaluation**
|
|
Rate FSS-Mini-RAG's effectiveness for:
|
|
- Finding specific information across multiple documents
|
|
- Searching complex documentation efficiently
|
|
- Helping with research and analysis workflows
|
|
- Overall usefulness for software development/tech industry applications
|
|
|
|
## 📁 **Deliverables**
|
|
- `api-design-research/` folder with research materials
|
|
- `RESULTS.md` with findings and FSS-Mini-RAG evaluation
|
|
- Documentation of your search queries and discoveries
|
|
|
|
## ⏱️ **Expected Duration**: 2-3 hours
|
|
|
|
## 🎓 **Learning Objectives**
|
|
- Test FSS-Mini-RAG with software development/tech industry content
|
|
- Evaluate search effectiveness with domain-specific documentation
|
|
- Assess usefulness for professional research workflows in software development/tech |