Dear IoTivity maintainers,


As a OSWG Developer Eco Build Chair, I?d like to request restructuring of
programming guide with proposal as follows

IoTivity Wiki page - New Section(Programming Guide) is built on
https://wiki.iotivity.org/start#programming_guide.



List can be as follows.

Initialize/Setting: initialization, connectivity setting  -
Discovery&Connectivity project

Resource Find/Registration                   - Discovery&Connectivity
project

Request and Response                        - Discovery&Connectivity project

Respond from Request                       - Discovery&Connectivity project

Observe                                          - Discovery&Connectivity
project

Presence                                         - Discovery&Connectivity
project

Common Resources                            - Discovery&Connectivity project

Collection                                        - Discovery&Connectivity
project

Provisioning                                     - Security project

Security - others                               - Security project

Resource Encapsulation - Server Builder  - Primitive Service Project

Resource Encapsulation - Client Broker/Cache      - Primitive Service
Project

Resource Container                            - Primitive Service Project

Resource Container Bundle                  - Primitive Service Project

Resource Hosting         (Not Ready)

Resource Directory                             - Primitive Service Project

Easy Setup                                      - Primitive Service Project

Scene Manager                                 - Primitive Service Project

Things Configuration Manager              - Primitive Service Project

Cloud - RD                                      - IoTivity Cloud Project

Cloud - OATH                                   - IoTivity Cloud Project

Cloud - others                                 - IoTivity Cloud Project



List is from my understanding, but please add or remove or merge or
separate if needed.. it?s up to maintainers.



Each title need to have following sections.

Description : Short introduction

Use Case/Features : Use case diagram, Feature list, if needed they can be
separate category.

Resource/Protocol Model : Related Resource Model with table, Protocol
sequence diagram will be welcome

Architecture : module diagram or interaction diagram or deployment diagram,
anything appropriate one.

API usage C : User perspective API class diagram will be welcome if needed,
for each use case show the API usage with sample code block. 

API usage C Arduino : per language (if supported)

API usage C++: per language (if supported)

API usage Java: per language (if supported)

Sample Application : Sample application explanation

Please refer to the sample at https://wiki.iotivity.org/scene_manager 



If it is done by 1.1.0 Release, it will be perfect.



BR, Uze Choi

-------------- next part --------------
HTML ?????? ??????????????...
URL: 
<http://lists.iotivity.org/pipermail/iotivity-dev/attachments/20160330/825e0652/attachment.html>

Reply via email to