Jeff Peters jeff@grokfusebox.com Fusedoc Success Jeff Peters jeff@grokfusebox.com
Fusedoc Is: A Documentation Standard XML Based (as of v2.0) File-header Oriented Created Before Coding
Fusedoc Isn't: Inline Documentation Documentation After The Fact Limited to ColdFusion
Why Use Fusedoc? Communication Focus Standardization Automation
What's In a Fusedoc? Responsibilities Properties IO Example: dspMyFamily.cfm
Writing Strong Fusedocs Takes Practice and Discipline Write, Set Aside, and Review Architectural Perspective Coding Perspective “Everything the coder needs to know, and nothing more.”
Fusedoc Maintenance Ideally, Fusedocs happen before coding Realistically, changes happen If code changes, Fusedocs should change (see Mindfuser)
Fusedoc Creation Tools Fusedoc VTMs for CF Studio Blank Fusedoc snippet Fusedoc generator – Joseph Devore Fusedoc Tools for UltraDev – Sandy Clark (shayna.com)
Fusedoc-Based Tools Possible due to standard XML eases the parsing pain
Harness Recurses application directory tree Generates a test harness file for each fuse Names harnesses as “tst_[fusefilename]” GrokFusebox.com
<CF_fusedoc2Struct> Reads the Fusedoc from a specified fuse. Parses Fusedoc into a CF XML variable. Example: dspMyFamily.cfm GrokFusebox.com
SecretAgents.com Fusedoc-based testing, code management, and Fusebox project management