Salesforce As-Is Documentation
Generate up-to-date, structured technical documentation of your Salesforce configuration.
Definition
Salesforce As-Is Documentation is the process of generating technical descriptions of a Salesforce system in its current state. It serves as a single source of truth for custom processes, configurations, and component dependencies.
Overview & Context
Manual technical documentation is obsolete the moment it is written. Writing As-Is documents for complex enterprise Salesforce orgs consumes weeks of engineering time. SF Analyzer automates this by creating a structured Markdown wiki containing a page for every custom component, linked in a dependency graph.
Important Architecture Notice
SF Analyzer strictly enforces the local data boundary. Your Salesforce metadata, credentials, and source files never leave your system.
TL;DR (Too Long; Didn't Read)
Generate a complete technical wiki documenting custom code, automations, and data models of your Salesforce org without manual writing.
Key Advantages
- Graph-First LayoutPages are linked bidirectionally based on component dependencies.
- Obsidian-Lite ViewerRendered with breadcrumbs, TOC, and syntax highlighted code blocks.
- Zero Stale DocsRigenerates the structural skeleton and documents delta changes instantly.
Typical Use Case
Essential for onboarding new developers to a project, preparing for architectural reviews, or handing over system configuration details to internal IT support teams.
Analysis Workflow
Analyze the custom metadata inventory and compile object and component relationships.
Generate a structured skeleton of Markdown files mapped to specific folders by metadata type.
Populate the skeleton with deterministic properties like dependencies, hub scores, and last modification dates.
Browse the resulting Obsidian-lite wiki inside the desktop application with native wikilinks and navigation trees.
How It Compares
Compare the secure local-first workflow against traditional cloud-based SaaS vendors.
| Approach | Manual Architecture Docs | SF Analyzer As-Is Wiki |
|---|---|---|
| Time to Generate | 2-4 weeks of senior developer interviews | Under 10 minutes of automated CLI analysis |
| Accuracy | Prone to omission, outdated diagrams | 100% accurate extraction of real Salesforce metadata |
| Maintenance | Requires manual updates that are rarely done | Incremental rebuilds based on git diffs between tags |
| Format | Scattered PDFs, Word docs, Confluence | Clean, local Markdown files compatible with Obsidian |
Frequently Asked Questions
Find answers to technical and operational questions about Salesforce As-Is Documentation.
Q:Can I export the generated wiki?
Yes. The wiki is stored in clean Markdown files in your local ~/.sf-analyzer/projects/ directory. You can import them directly into Obsidian, check them into your Git repository, or convert them to HTML.
Q:Does the wiki include customer data?
No. The As-Is wiki documents metadata configuration, schemas, and code logic. It never reads or writes actual customer records (such as Accounts, Contacts, or Opportunities).
Ready to assess your Salesforce Org?
Download the SF Analyzer desktop application. Connect your sandbox or production org via the CLI, and run the assessment 100% locally.