![Page 1: LavaCon 2011: Double Trouble! Adding Developer Docs to Your Deliverables](https://reader034.vdocument.in/reader034/viewer/2022042714/555b0ea4d8b42ae0418b5204/html5/thumbnails/1.jpg)
LavaCon ConferenceNovember 15, 2011
Mary Connor and Nicky Bleiel
Double Trouble!Adding Developer Docs to Your Deliverables
![Page 2: LavaCon 2011: Double Trouble! Adding Developer Docs to Your Deliverables](https://reader034.vdocument.in/reader034/viewer/2022042714/555b0ea4d8b42ae0418b5204/html5/thumbnails/2.jpg)
Presenters
Mary Connor Documentation Architect,
Advanced Solutions International www.cleverhamster.com [email protected]
Nicky Bleiel Lead Information Developer,
ComponentOne Doc-To-Help www.nickybleiel.com [email protected]
![Page 3: LavaCon 2011: Double Trouble! Adding Developer Docs to Your Deliverables](https://reader034.vdocument.in/reader034/viewer/2022042714/555b0ea4d8b42ae0418b5204/html5/thumbnails/3.jpg)
What are API docs?
• application programming interface (API)
Creating a public API for your application — and documenting it — lets third-party developers
• extend what your application can do• integrate your functionality into theirs
…which means $
![Page 4: LavaCon 2011: Double Trouble! Adding Developer Docs to Your Deliverables](https://reader034.vdocument.in/reader034/viewer/2022042714/555b0ea4d8b42ae0418b5204/html5/thumbnails/4.jpg)
2000: Coder-free hand-off to writer• API to write web pages that talk to back office• Document! X by Innovasys
added
![Page 5: LavaCon 2011: Double Trouble! Adding Developer Docs to Your Deliverables](https://reader034.vdocument.in/reader034/viewer/2022042714/555b0ea4d8b42ae0418b5204/html5/thumbnails/5.jpg)
2005: Hands-free, writer-free• NDoc automated builds
No overviews
![Page 6: LavaCon 2011: Double Trouble! Adding Developer Docs to Your Deliverables](https://reader034.vdocument.in/reader034/viewer/2022042714/555b0ea4d8b42ae0418b5204/html5/thumbnails/6.jpg)
Drupal wiki for dev articles
Link to Help
Starter articles
![Page 7: LavaCon 2011: Double Trouble! Adding Developer Docs to Your Deliverables](https://reader034.vdocument.in/reader034/viewer/2022042714/555b0ea4d8b42ae0418b5204/html5/thumbnails/7.jpg)
Web 2.0 world: web controls + web services
Suddenly, API was our core business!
1. internal developers create all new functionality using SOA
2. third-party developers need SOA to use and extend our product, as well as to integrate their own products
Presentation•HTML, web controls•Devices, phones
Services•Web service, SOA•Decentralization
Back-end•SQL databases•Content management
![Page 8: LavaCon 2011: Double Trouble! Adding Developer Docs to Your Deliverables](https://reader034.vdocument.in/reader034/viewer/2022042714/555b0ea4d8b42ae0418b5204/html5/thumbnails/8.jpg)
Enter Sandcastle, for .NET and VS
• The promise of Intellisense• The pain of Microsoft XAML
![Page 9: LavaCon 2011: Double Trouble! Adding Developer Docs to Your Deliverables](https://reader034.vdocument.in/reader034/viewer/2022042714/555b0ea4d8b42ae0418b5204/html5/thumbnails/9.jpg)
Serendipity! Doc-To-Help
• We’d just migrated to Doc-To-Help, for Agile• Doc-To-Help includes a
Sandcastle plug-in• Easy authoring• Complete integration
of conceptual with API• NO NEW COSTS!
Happy dance
![Page 10: LavaCon 2011: Double Trouble! Adding Developer Docs to Your Deliverables](https://reader034.vdocument.in/reader034/viewer/2022042714/555b0ea4d8b42ae0418b5204/html5/thumbnails/10.jpg)
Our Doc-To-Help Solution
DOCX-based content
Code-generated content Embedded diagrams
![Page 11: LavaCon 2011: Double Trouble! Adding Developer Docs to Your Deliverables](https://reader034.vdocument.in/reader034/viewer/2022042714/555b0ea4d8b42ae0418b5204/html5/thumbnails/11.jpg)
What is Sandcastle?
Sandcastle is a documentation generator from Microsoft that automatically produces MSDN style reference documentation out of reflection information of .NET assemblies and XML documentation comments found in the source code of these assemblies. (Whew.)
Source: wikipedia
![Page 12: LavaCon 2011: Double Trouble! Adding Developer Docs to Your Deliverables](https://reader034.vdocument.in/reader034/viewer/2022042714/555b0ea4d8b42ae0418b5204/html5/thumbnails/12.jpg)
Doc-To-Help + SandcastleStart with the Doc-To-Help Sandcastle plug-in and add…• Assembly file (.dll)• XML comments file(s) (.xml)…to create MSDN-style reference docs
What Doc-To-Help does:• Automatically creates the Table of Contents and Index based on the structure
of the assembly.• Gives you the power to create 6 different types of outputs:
– Microsoft Help Viewer (integrates with Visual Studio 2010)– Help 2.0 (integrates with Visual Studio 2007 and 2005)– HTML Help– NetHelp (browser-based Help)– WinHelp– JavaHelp
• Makes it possible (& easy) to link “Narrative” content to the reference docs.
![Page 13: LavaCon 2011: Double Trouble! Adding Developer Docs to Your Deliverables](https://reader034.vdocument.in/reader034/viewer/2022042714/555b0ea4d8b42ae0418b5204/html5/thumbnails/13.jpg)
Sandcastle Ribbon
![Page 14: LavaCon 2011: Double Trouble! Adding Developer Docs to Your Deliverables](https://reader034.vdocument.in/reader034/viewer/2022042714/555b0ea4d8b42ae0418b5204/html5/thumbnails/14.jpg)
Demo
![Page 15: LavaCon 2011: Double Trouble! Adding Developer Docs to Your Deliverables](https://reader034.vdocument.in/reader034/viewer/2022042714/555b0ea4d8b42ae0418b5204/html5/thumbnails/15.jpg)
Other Integrations
• Team Foundation Server• SharePoint
![Page 16: LavaCon 2011: Double Trouble! Adding Developer Docs to Your Deliverables](https://reader034.vdocument.in/reader034/viewer/2022042714/555b0ea4d8b42ae0418b5204/html5/thumbnails/16.jpg)
Translation ManagementDon’t miss Brad’s talk 3 pm today Automating Translation Management and Locale-specific Builds
![Page 17: LavaCon 2011: Double Trouble! Adding Developer Docs to Your Deliverables](https://reader034.vdocument.in/reader034/viewer/2022042714/555b0ea4d8b42ae0418b5204/html5/thumbnails/17.jpg)
What’s next?
• Move API documentation project to Dev’s build machines
• Integrate D2H project fully into TFS• Rebuild API documentation when code
checked in • Sourcing conceptual diagrams in cloud tool• Localization requirements and options
![Page 18: LavaCon 2011: Double Trouble! Adding Developer Docs to Your Deliverables](https://reader034.vdocument.in/reader034/viewer/2022042714/555b0ea4d8b42ae0418b5204/html5/thumbnails/18.jpg)
Questions?