documentation insight技术架构与开发历程
TRANSCRIPT
Documenta*on Insight
技术架构与开发历程
左保权
左保权
• Spring Framework for Delphi 创始人 • DevJET.net 创始人 • 盛大创新院 麦库项目组
Spring Framework for Delphi
背景介绍
Technical Writers
• Help Authoring – Overview – GeCng started – How to – …
• API Documenta*on – JavaDoc – XMLDoc
XMLDoc /// <summary>Provides access to informa*on on a drive.</summary>
/// <remarks>
/// Use the sta*c <see cref=“Spring.U*ls|TDriveInfo.GetDrives“ />
/// method to retrieve all drives of the computer.
/// <note type="caller">
/// Caller must use the <see cref="Spring.U*ls|TDriveInfo.IsReady">IsReady</see>
/// property to check whether the drive is ready before accessing other members. Otherwise,
/// an <see cref="Spring|EIOExcep*on“ /> excep*on will be raised if
/// it is not ready.
/// </note>
/// </remarks> TDriveInfo = record //… end;
Help Insight
优点 • XML, XPath, XSLT • Inline Documenta*on – IDE支持
• 语法提示 • 重构支持
缺点 • 为机器而设计 • 不便于阅读 • 不易编辑和维护
产品演示
• Documenta*on Insight Demo
技术架构
Documenta*on Insight
Add-‐in
Transforma*ons （XML <-‐> HTML）
Code Model
Code Model
构造Code Model
• Lexer – 词法定义 – Input: Stream – Output: Tokens
• Parser – 语法定义 – 抽象语法树（Abstract Syntax Tree） – 符号表（Symbols） – 语义分析
Transforma*ons
• XML to XHTML • XHTML to XML
XSLT
• Extensible Stylesheet Language Transforma*ons
• Data Presenta*on (Style) • Data Transforma*on (Exchange)
• Rule-‐Based Programming Language
<?xml version="1.0" encoding="UTF-‐8" ?> <xsl:stylesheet version="1.0" xmlns:xsl="hbp://www.w3.org/1999/XSL/Transform">
<xsl:template match="/"> <html xmlns="hbp://www.w3.org/TR/xhtml1"> <head> <*tle>Documenta*on</*tle> </head> <body> <div id="mainSec*on"> <div id="mainBody"> <xsl:call-‐template name="insertSec*ons" /> </div> </div> </body> </html> </xsl:template>
</xsl:stylesheet>
Add-‐in
• Extending Delphi IDE – Splash Screen – Menus – Hotkeys – No*fica*ons – Installa*on/Uninstalla*on – Dockable Form
WebBrowser Customiza*on
• designMode vs contentEditable • Execute Script • External
产品与市场
缘起
• 为Spring4d项目写API Documenta*on • 商业尝试
定位
• 需求 – 同步浏览文档和代码 – 编写API文档更简单
• 用户 – 国外Delphi开发者社区 – Code Library或组件作者 – 公司内部开发团队
战略
• Standard – Delphi Documenta*on Guidelines
• Documenta*on Insight • Documenta*on Generator • Incorpora*ons – H&M – Embarcadero
定价
• $10-‐15 • $49-‐69 • $89-‐99 • >$100
销售
• Hos*ng – Hostmonster
• WordPress
• Sales Plamorm – Share It!
• Gross Price/Net Price (VAT) • Margin: 4.9% + 1 USD/EUR per license • Payment cycle • Promo*ons • Refund
推广与合作
• 与CnPack结成战略合作伙伴 • 赞助Open Source Projects • 邀请知名开发者试用 • 交换Licenses
• 后续： • Google Ads &SEO • 推出Express版本，争取和下一代Delphi IDE捆绑销售 • 和其他厂商合作，Help & Manual, Doc-‐O-‐Ma*c等等
未来尝试
• 稳固和扩大Delphi市场，加强第三方合作 • 尝试进入Visual Studio市场
思考与建议
• 选择一个好方向 • 最终用户的反馈 • V1.0 • 注重用户体验和软件质量
