Web services Web服务的文档标准/结构/样式

Web services Web服务的文档标准/结构/样式,web-services,documentation,standards,Web Services,Documentation,Standards,有人能推荐Web服务的高级文档指南吗 这是一个文档,它应该允许不了解特定Web服务的人对其存在的原因、路线图和使用示例有一个基本的了解 此类文件应放在A4/信纸的两个印刷面上,且阅读时间不超过10分钟 请注意,这是对开发人员使用接口时使用的低级API文档的补充。我不确定是否有指导原则,但我可以向您展示一个示例,我发现这是一组很好的web服务API文档 Flickr API页面以非常可读的形式进行设置。本页面主要有: 指向概述页面的链接 常见场景的编写 在此实例中上载照片 有关使用API的工具的信

有人能推荐Web服务的高级文档指南吗

这是一个文档,它应该允许不了解特定Web服务的人对其存在的原因、路线图和使用示例有一个基本的了解

此类文件应放在A4/信纸的两个印刷面上,且阅读时间不超过10分钟


请注意,这是对开发人员使用接口时使用的低级API文档的补充。

我不确定是否有指导原则,但我可以向您展示一个示例,我发现这是一组很好的web服务API文档

Flickr API页面以非常可读的形式进行设置。本页面主要有:

指向概述页面的链接 常见场景的编写 在此实例中上载照片 有关使用API的工具的信息 每个API的详细说明 方法,按活动分组
特别是,对我来说,描述上传照片、替换照片的公共访问模式的页面至关重要。它们向API的使用者展示了如何做常见的事情,以及您希望人们如何使用您的API。最后一点很重要-你想说,嘿,我们希望你像这样打电话给我们,使用这些方法,进行这种错误处理。向您的用户展示一些有关API使用的最佳实践,您将节省大量的支持调用。

我不确定是否有指导原则,但我可以向您展示一个示例,我发现这是一套很好的web服务API文档

Flickr API页面以非常可读的形式进行设置。本页面主要有:

指向概述页面的链接 常见场景的编写 在此实例中上载照片 有关使用API的工具的信息 每个API的详细说明 方法,按活动分组
特别是,对我来说,描述上传照片、替换照片的公共访问模式的页面至关重要。它们向API的使用者展示了如何做常见的事情,以及您希望人们如何使用您的API。最后一点很重要-你想说,嘿,我们希望你像这样打电话给我们,使用这些方法,进行这种错误处理。向您的用户展示一些API使用方面的最佳实践,您将节省大量的支持调用。

这个问题对于google的textbox来说是否太大了;这个问题对谷歌的文本框来说太大了吗;