Documentation Plan: Reference Platform MDK Documentation This document describes the plan for release of documentation for the Middleware Development Kit (MDK) for Reference Platform. Contents Product Information ..................................................................................................... 1 Schedule ..................................................................................................................... 2 Review and Approval Teams ...................................................................................... 2 Document Plan ..................................................................................................... 2 Document Set ....................................................................................................... 2 Document Specifications ............................................................................................. 3 Audience ............................................................................................................... 3 Documents Planned for Release .......................................................................... 3 Documents Available for MDKs ..................................................................... 3 Chapters Planned for Release .............................................................................. 3 Getting Started Chapters ............................................................................... 4 Developer Guide Chapters ............................................................................. 4 API Reference Chapters ................................................................................ 5 Product Information This plan is for the creation of documentation to support middleware development as follows. Item Details Marketing Name Version Reference Platform Platform <ExplorerModel>, <ExplorerModel> Scope Creation of full document set for Reference Platform MDK Assumptions Cisco Confidential • Document set will implement Cisco templates for technical documentation for external audiences. • Document set will be published to www.cisco.com. 10/19/10 Reference Platform 3 Document Specifications This section provides the following information: • • • Audience for this documentation set Documents planned for release Chapters planned for release Audience This documentation set is for Middleware developers looking to integrate with the Reference Platform, as well as Application developers writing applications for the Reference Platform Stack. Documents Planned for Release This section lists documents available for release. Information for each document is provided as follows. • Milestones for the release appear in the column Milestone. If no milestone is present, the document is not being included in the release. • Changes to documents are marked by a triangle (▲). - As Is means the document exists and no changes are anticipated. - Rev means the document exists and revisions are anticipated. - New means the document does not exist and needs to be written in full. This table lists documents available for inclusion in MDKs. Document Milestone As Is Rev New Getting Started <Release Date> ▲ Developer Guide <Release Date> ▲ API Reference <Release Date> ▲ Chapters Planned for Release This section lists chapters available for only those documents being released as noted in "Documents Planned for Release". Getting Started Chapters Getting Started Chapter Source Documents Table of Contents Preface Cisco Confidential 10/19/10 Reference Platform 4 Getting Started Chapter Source Documents Overview of Reference Platform Development Process • Reference Platform Application • Reference Platform Environment • Developer QuickStart - Noted some similarities in the processes, but RP uses different tools and libraries than were used in the PowerTV OS documentation. • Axiom 1.6 OCAP Application Developer’s Guide - This was written for development in a Windows environment. It can be used as a guide, but there will be many changes to update the content for Linux. • PowerTV OS Getting Started - Most of the tasks appear to be the same for OS Linux, and RP. We need to change tools and libraries as appropriate, and bring in the middleware part for Linux. Setting Up Your Development Environment • Overview of the Developer Platform Kit • Connecting Your Hardware • Installing the Reference Platform SDK • Configuring Your System for Development Under Linux Same as above Using Your Development Environment • Using Sample Applications • Building Reference Platform Applications • Launching Reference Platform Applications Same as above Creating and Debugging Applications • Building a New Project • Debugging Reference Platform Applications Same as above Developer Guide Chapters Developer Guide Chapter Source Documentation Diagnostics Module CPERP_Diag_SDD.doc cpe-public-api.pdf DirectFB Extension Module cpe-public-api.pdf • IAVOutput cpe-public-api.pdf • IMediaStreamHandler CPERP_Media_Manager_SDD.doc CPERP_SDD_IVideoStreamHandler.doc cpe-public-api.pdf •• IVideoStreamHandler CPERP_SDD_IVideoStreamHandler.doc cpe-public-api.pdf •• ITextStreamHandler Cisco Confidential 10/19/10
© Copyright 2024 ExpyDoc
