sf-agent-framework/sf-core/tasks/document-org.md

AI Agent Orchestration Framework for Salesforce Development - Two-phase architecture with 70% context reduction

# Document Salesforce Org

## Overview

Comprehensive documentation task for existing Salesforce orgs. Analyzes and
documents the current state of a Salesforce implementation including
configuration, customization, code, integrations, and technical architecture.

## When to Use

- Before major org enhancements or migrations
- When onboarding new team members
- For compliance or audit requirements
- Before architectural reviews
- When planning technical debt reduction
- To establish baseline documentation

## Prerequisites

- Access to target Salesforce org
- Appropriate permissions (View All Data, View Setup)
- Understanding of org's business context

## Task Steps

### 1. Org Overview Analysis

Analyze and document high-level org information:

- Org edition and licenses
- Business purpose and use cases
- User base and profiles
- Key business processes supported
- Integration landscape overview

### 2. Data Model Documentation

Document the org's data architecture:

- Custom objects and relationships
- Key standard object customizations
- Record types and page layouts
- Field usage and dependencies
- Data volume assessments
- Sharing model and security

### 3. Configuration Inventory

Catalog declarative customizations:

- Process automation (Flows, Process Builder, Workflow Rules)
- Validation rules and formulas
- Email templates and alerts
- Reports and dashboards
- List views and apps

### 4. Code Analysis

Document programmatic customizations:

- Apex classes and triggers
- Lightning Web Components
- Visualforce pages and components
- Static resources
- Code quality and test coverage

### 5. Integration Documentation

Map external system connections:

- REST/SOAP integrations
- Middleware platforms
- Connected apps
- External services
- Data synchronization patterns

### 6. Security Architecture

Document security implementation:

- Profiles and permission sets
- Role hierarchy
- Sharing rules and teams
- Field-level security
- Authentication methods

### 7. Technical Debt Assessment

Identify improvement opportunities:

- Deprecated features in use
- Code quality issues
- Performance bottlenecks
- Security vulnerabilities
- Maintenance challenges

### 8. Generate Documentation

Create comprehensive documentation set:

- Executive summary
- Technical architecture document
- Data dictionary
- Integration specifications
- Security model documentation
- Maintenance guide

## Input Format

```yaml
org_info:
  name: 'Production Org'
  type: 'Production|Sandbox|Developer'
  edition: 'Enterprise|Unlimited|Professional'

documentation_scope:
  include_code_analysis: true
  include_integration_details: true
  include_security_audit: true
  include_performance_metrics: true

access_level:
  has_full_sandbox: true
  can_use_tooling_api: true
  metadata_api_access: true
```

## Output Format

The task generates multiple documentation files:

1. **org-overview.md** - Executive summary and high-level architecture
2. **data-model.md** - Comprehensive data dictionary and ERD
3. **technical-architecture.md** - Detailed technical implementation
4. **integration-specifications.md** - API and integration documentation
5. **security-model.md** - Security architecture and compliance
6. **maintenance-guide.md** - Operational procedures and best practices

## Best Practices

- Use metadata API for accurate configuration details
- Include visual diagrams where helpful
- Document both current state and recommendations
- Version control all documentation
- Keep security information appropriately restricted
- Update documentation after major changes

## Related Resources

- architecture-review checklist
- data-model-tmpl template
- technical-design-tmpl template
- security-audit task