终端开发

使用Android Studio开发可独立运行(runnable)混淆过的Jar程序 Android安装包精简系列之资源精简 Android安装包精简系列之图片优化 Android安装包精简系列之为什么要优化精简安装包 Android安装包精简系列(总纲) Android安装包精简系列之图标转字体 gradle相关资料汇总 Android编译常见错误解决 Android编译编译速度提升 终端基于gradle的开源项目运行环境配置指引 制作终端产品演示的gif 一个关于APK Signature Scheme v2签名的神奇bug定位经历 如何随apk一起打包并使用SQLite SDK热更之gradle插件(如何在SDK代码中自动插桩及如何生成补丁包) 关于Android的APK Signature Scheme v2签名相关的资料汇总 封装HttpURLConnection实现的简单的网络请求库 一款基于Java环境的读取应用包名、签名、是否V2签名等基本信息的工具 Android的APK Signature Scheme v2签名及一款基于Java环境的校验工具介绍 如何使用Eclipse开发可执行Jar程序,并生成混淆过的jar程序 Android 相关的学习资料整理(持续更新) macOS(Sierra 10.12)上Android源码(AOSP)的下载、编译与导入到Android Studio Google也看不下去被玩坏的悬浮窗了么? Android开发常用工具资源 SDK热更系列之概述(持续整理编辑中~) SDK热更系列之SDKHotfix待优化点 Android 终端开发相关的一些神图(持续更新) SDK热更系列之Demo项目介绍概述 SDK热更系列之Demo体验方法 SDK热更系列之如何获取应用在当前设备上的so对应的指令集 Gradle Android插件使用的中那些特别注意的点 Experimental Plugin User Guide(From Android Tools Project Site) 基于Android Studio使用gradle构建包含jni以及so的构建实例 基于Instrumentation框架的自动化测试 - Android自动化测试系列(四) Instrumentation框架介绍-Android自动化测试系列(三) 关于终端设备的设备唯一性的那些事之MAC地址 关于终端设备的设备唯一性的那些事之IMEI Android 检查应用是否有root权限 ant常见错误解决方案 Gradle介绍 iMac上Android Studio 相关设置及常见问题 再说adb 再看Android官方文档之分享 再看Android官方文档之Fragment&数据保存 再看Android官方文档之Activity&Intent 再看Android官方文档之ActionBar和兼容性 adb shell input(Android模拟输入)简单总结 再看Android官方文档之建立第一个APP Android开发调试常用工具 ANR(网络资料整理) Java参数引用传递引发的惨案(又一次Java的String的“非对象”特性的踩坑经历) android.view.WindowManager$BadTokenException,Unable to add window Android签名校验机制(数字证书) Robotium二三事-Android自动化测试系列(二) Robotium介绍-Android自动化测试系列(一) Android开发中遇到的那些坑 Eclipse使用中部分经验总结 Android中关于Nativa编译(NDK、JNI)的一些问题 Android简单实现的多线程下载模块 Android内存耗用之VSS/RSS/PSS/USS adb Advanced Command URL编码中的空格(编码以后变为+) Android MD5后 bye数组转化为Hex字符串的坑(记一次为女神排忧解难的经历) Android学习之路 adb Base Command Android Log的那些坑…………

标签

android 46

Android编译常见错误解决 一个关于APK Signature Scheme v2签名的神奇bug定位经历 关于Android的APK Signature Scheme v2签名相关的资料汇总 封装HttpURLConnection实现的简单的网络请求库 一款基于Java环境的读取应用包名、签名、是否V2签名等基本信息的工具 Android的APK Signature Scheme v2签名及一款基于Java环境的校验工具介绍 如何使用Eclipse开发可执行Jar程序,并生成混淆过的jar程序 Android 相关的学习资料整理(持续更新) macOS(Sierra 10.12)上Android源码(AOSP)的下载、编译与导入到Android Studio Android开发常用命令备忘 Google也看不下去被玩坏的悬浮窗了么? Android开发常用工具资源 Android 终端开发相关的一些神图(持续更新) Gradle Android插件使用的中那些特别注意的点 Experimental Plugin User Guide(From Android Tools Project Site) iMac(OS X)搭建私有maven仓库,提供Nexus Responsitory镜像 基于Android Studio使用gradle构建包含jni以及so的构建实例 基于Instrumentation框架的自动化测试 - Android自动化测试系列(四) Instrumentation框架介绍-Android自动化测试系列(三) 关于终端设备的设备唯一性的那些事之MAC地址 关于终端设备的设备唯一性的那些事之IMEI Android 检查应用是否有root权限 iMac(OS X)El Capitan 更新遇到的那些坑 ant常见错误解决方案 Gradle介绍 iMac上Android Studio 相关设置及常见问题 再说adb 再看Android官方文档之分享 再看Android官方文档之Fragment&数据保存 再看Android官方文档之Activity&Intent 再看Android官方文档之ActionBar和兼容性 adb shell input(Android模拟输入)简单总结 再看Android官方文档之建立第一个APP Android开发调试常用工具 ANR(网络资料整理) Java参数引用传递引发的惨案(又一次Java的String的“非对象”特性的踩坑经历) android.view.WindowManager$BadTokenException,Unable to add window Android签名校验机制(数字证书) Eclipse使用中部分经验总结 Android内存耗用之VSS/RSS/PSS/USS adb Advanced Command URL编码中的空格(编码以后变为+) Android MD5后 bye数组转化为Hex字符串的坑(记一次为女神排忧解难的经历) Android学习之路 adb Base Command Android Log的那些坑…………

SDK开发经验之Demo

2015年05月19日

为什么要有

好吧发现这个和要说为什么文档要有一样也好蛋疼。简单说一下吧。

  1. 程序猿都是艺术家,你提供的接口被使用的方法只有你想不到的,没有他们做不到的,没有一个事例他们容易用错。
  • 好吧,其实关键是很多程序猿都很懒,他们想你都有接口API了,那怎么调用的也写一下么,我就直接拷过来改改参数就好了。所以他们就会说你们的SDK不好接入,你们要优化,要有调用事例,胳膊拧不过大腿,最终就都有了。

  • 好吧,其实还有程序猿们都很有怀疑精神,虽然有文档,他们也是按照文档做的,可是他们总不放心,因此demo显得就很重要,他有可以参考的对象了。

  • 文档并不能非常整体的、清晰的展现你的SDK的整个系统和调用方式。

  • 对于刚接触你SDK的人,你用一个demo来介绍SDK的功能会比文档形象更多,也更易理解。一图胜千言,一demo胜千图应该也是可以的。

最后,再把知乎上关于文档别人说的这一段描述修改下,发现更加恰当了(点击前往知乎):

仅仅通过他人的口述、视频、文档往往无法完整的了解到SDK的接口的所有的作用,好比盲人摸象,你对它的认知、印象、经验将完完全全从他人所提供的教程中继承而来。而Demo能够全面地介绍出它所包含的所有内容,能够辅助你学习如何“使用”它。

展现形式

  • 最好是独立的包含完整功能的APK应用:如果只是部分模块或者部分接口的事例代码,那么文档足矣,根本无需Demo

  • 虽然Demo的主要功能是为了协助用户了解SDK的功能,但是也别太丑了:之前我们的Demo丑到我都看厌了,不好意思拿出手。

  • Demo中功能演示最好也分模块来展示,而不是把所有的功能揉在一起:我们的SDK有几十个接口,Demo最开始所有的功能用一个自动生成的ListView放在一起,加上配色的问题,每次测试某个功能都要找呀找,找不到我要的小伙伴。

  • 既然都Demo了,大部分活都做了就多做一点,在展示某个功能的时候,能把调哪个接口、什么效果、注意事项等都简单说明下。别整个Demo就是把功能跑一遍,要看某个功能是调哪个接口,调用要注意什么还要去看代码和文档。(最开始我们就是这么做的)

注意要点

  1. Demo对接口的使用方法一定要和文档要求或者推荐的一致。本来文档加Demo的目的是减少接入咨询的工作量。结果你这俩都不一样,全来问了,还不如没有呢,不是自己打自己脸么(很不幸,我们被打过)。
  2. Demo中与接口调用事例无关的代码要尽可能的少虽然说不能太丑,但是也不能太花里胡哨,如果想花里胡哨,那部分代码最好不要和接口的调用事例的代码柔和在一起。不然开发看懂你的demo的时间他都接完了。

暂时就写这么多,之前感觉挺难写的,发现逗比起来就好写多了,暂时这么多,后续想起来慢慢补充。



PS:我的博客即将搬运同步至腾讯云+社区,邀请大家一同入驻:https://cloud.tencent.com/developer/support-plan?invite_code=10zhijuy24v4f

赞赏

取消
微信扫一扫,赞赏子勰
扫码支持
屌丝程序猿,鸡血攻城狮!努力学技术,潜心做精品!