Re: [Techshoret] How to get Android's documentation appearance (http://developer.android.com)

Subject: Re: [Techshoret] How to get Android's documentation appearance (http://developer.android.com)
From: Laura Lemay <lemay -at- lauralemay -dot- com>
To: SB <sylvia -dot- braunstein -at- gmail -dot- com>
Date: Wed, 29 Jun 2011 10:08:08 -0700


I don't know specifically how Google does their android docs -- I haven't worked there. But we did something extremely similar for the developer documentation at Yahoo, and it was all hand-coded in HTML/CSS/Javascript/PHP, with the API reference docs generated out of the code from custom versions of Javadoc and doxygen developed in-house. The entire doc set was built from code and HTML source as if it were an application. Writers were expected to behave like engineers and work in the source, check everything into a source code control system, and do local builds to ensure new edits and changes did not break the overall build. We used no GUI tools more sophisticated than Dreamweaver.

I designed most of this system myself, with the goal to get the docs as close to the source as possible, and to be able to do continuous integration and frequent releases. In my experience it's easier to maintain developer docs if there are fewer people and fewer barriers between the developers and the docs. In this world writers *are* developers, are fully integrated into developer teams, and are using most of the same tools. The tradeoff is that you lose the power of the high-level documentation tools for writing, formatting, review, indexing, and so on. We worked specifically with writers who were comfortable in the code. Obviously this isn't a solution that isn't going to work with a lot of companies, especially those who are still doing "traditional" documentation and help.

Given the very high level of technical geekery at Google, I would assume they are doing something similar and it's all an internally-built custom system.

Laura


On Jun 29, 2011, at 6:44 AM, SB wrote:

> Posting on behalf of a friend and colleague.
> **
>
>
> Hi all,
>
> I have recently had a couple of people ask me how to copy the documentation
> appearance of Android (http://developer.android.com) for their own
> documentation, especially for SDK documentation and developers guide
> documentation:
>
> e.g.,
>
> http://developer.android.com/sdk/index.html
>
> http://developer.android.com/sdk/android-3.1-highlights.html
>
> Fairly recently there was a thread on this in the APIWriters forum (
> http://tech.groups.yahoo.com/group/APIWriters/message/506).
>
> I asked the thread initiator if she received a complete and final answer,
> and she said:
>
> Not really! Did not figure it out yet.
> It is partially javadoc and
> some plug-ins in Eclipse and/or visual studio.
> Can't figure it out completely yet. Still studying this.
>
> Does anybody know the documentation appearance of Android was achieved? I
> would like to give somebody some direction on this today.
>
> TIA
>
> Regards,
>
> avraham
>
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> Avraham Makeler
>
> Freelance Technical Writer
>
> Tel: +972 (0)54-3084-886
>
> Fax: +972 (0)8-945-1624
>
> amakeler -at- gmail -dot- com
>
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> Programmer's and User's Guides * APIs & SDKs * Embedded Systems
>
> Advanced Office Templates & Automation
>
> White Papers * Video Scripts
>
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> [Non-text portions of this message have been removed]
>
> __._,_.___
> Reply to sender<amakeler -at- gmail -dot- com?subject=Re%3A%20How%20to%20get%20Android%27s%20documentation%20appearance%20%28http%3A%2F%2Fdeveloper%2Eandroid%2Ecom%29>|
> Reply
> to group<techshoret -at- yahoogroups -dot- com?subject=Re%3A%20How%20to%20get%20Android%27s%20documentation%20appearance%20%28http%3A%2F%2Fdeveloper%2Eandroid%2Ecom%29>|
> Reply
> via web post<http://groups.yahoo.com/group/techshoret/post;_ylc=X3oDMTJvZ241ZTdoBF9TAzk3MzU5NzE0BGdycElkAzg5NTk0BGdycHNwSWQDMTcwNjAzMDQyOQRtc2dJZAM0ODMwMwRzZWMDZnRyBHNsawNycGx5BHN0aW1lAzEzMDkzMzAxMTE-?act=reply&messageNum=48303>|
> Start
> a New Topic<http://groups.yahoo.com/group/techshoret/post;_ylc=X3oDMTJjbWRmMjEwBF9TAzk3MzU5NzE0BGdycElkAzg5NTk0BGdycHNwSWQDMTcwNjAzMDQyOQRzZWMDZnRyBHNsawNudHBjBHN0aW1lAzEzMDkzMzAxMTE->
> Messages in this
> topic<http://groups.yahoo.com/group/techshoret/message/48303;_ylc=X3oDMTM0ZnIxZTFuBF9TAzk3MzU5NzE0BGdycElkAzg5NTk0BGdycHNwSWQDMTcwNjAzMDQyOQRtc2dJZAM0ODMwMwRzZWMDZnRyBHNsawN2dHBjBHN0aW1lAzEzMDkzMzAxMTEEdHBjSWQDNDgzMDM->(
> 1)
> Recent Activity:
>
> - New Members<http://groups.yahoo.com/group/techshoret/members;_ylc=X3oDMTJkbW5iaWIwBF9TAzk3MzU5NzE0BGdycElkAzg5NTk0BGdycHNwSWQDMTcwNjAzMDQyOQRzZWMDdnRsBHNsawN2bWJycwRzdGltZQMxMzA5MzMwMTEx?o=6>
> 1
>
> Visit Your Group<http://groups.yahoo.com/group/techshoret;_ylc=X3oDMTJjN2hrMzU1BF9TAzk3MzU5NzE0BGdycElkAzg5NTk0BGdycHNwSWQDMTcwNjAzMDQyOQRzZWMDdnRsBHNsawN2Z2hwBHN0aW1lAzEzMDkzMzAxMTE->
> Techshoret Communicators Forum
> Serving the Israeli Technical Communicator since 1996
>
> MEGAComm - The SIXTH Annual MEGAComm conference will take place in Jerusalem
> on February 16, 2012. We are interesting in receiving proposals from those
> interested in presenting, ideas for presentations, and contact from those
> interested in sponsoring! MEGAComm will again combine both MARCOM for
> marketing professionals and Technical Writing presentations for Technical
> Communicators, Documentation Managers, etc. For details and a discounted
> early registration, write to: MEGAComm -at- techshoret -dot- com
>
> For updates, course information, helpful links and conference details (when
> they are available), see: www.techshoret.com
>
> ~~~~~~~~~~~~~~~~~~~~~~~Our Sponsors~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> ** WritePoint Ltd. / WritePoint Training Center **
> Crash Course in Social Media / Translation / Crash Course in WordPress /
> Information Design / Technical Writing / MARKETING Communication and
> more...Check out the WritePoint Staff Blog: www.writepoint.com/blog
>
> --------------------------------------------------------
> Want to share your message here? Contact the moderators for details.
> [image: Yahoo! Groups]<http://groups.yahoo.com/;_ylc=X3oDMTJibmx1NWhyBF9TAzk3MzU5NzE0BGdycElkAzg5NTk0BGdycHNwSWQDMTcwNjAzMDQyOQRzZWMDZnRyBHNsawNnZnAEc3RpbWUDMTMwOTMzMDExMQ-->
> Switch to: Text-Only<techshoret-traditional -at- yahoogroups -dot- com?subject=Change+Delivery+Format:+Traditional>,
> Daily Digest<techshoret-digest -at- yahoogroups -dot- com?subject=Email+Delivery:+Digest>•
> Unsubscribe <techshoret-unsubscribe -at- yahoogroups -dot- com?subject=Unsubscribe>
> • Terms
> of Use <http://docs.yahoo.com/info/terms/>
> .
>
> __,_._,___
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> Create and publish documentation through multiple channels with Doc-To-Help.
> Choose your authoring formats and get any output you may need. Try
> Doc-To-Help, now with MS SharePoint integration, free for 30-days.
> http://www.doctohelp.com
>
> ---
> You are currently subscribed to TECHWR-L as lemay -at- lauralemay -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit http://lists.techwr-l.com/mailman/options/techwr-l/lemay%40lauralemay.com
>
>
> To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
> http://www.techwr-l.com/ for more resources and info.
>
> Please move off-topic discussions to the Chat list, at:
> http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat
>

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days.
http://www.doctohelp.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


References:
Fwd: [Techshoret] How to get Android's documentation appearance (http://developer.android.com): From: SB

Previous by Author: Re: Creating a template with locked
Next by Author: Re: Has anyone noticed...
Previous by Thread: Fwd: [Techshoret] How to get Android's documentation appearance (http://developer.android.com)
Next by Thread: Displaying extra information in Visio


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads