Merge pull request #35 from webscreens/issue-5-template

Adds template for discovery & tweak transport template

ssdp.md

@@ -282,7 +282,7 @@ obtained from the application level protocol implemented on that endpoint.  The
 friendly name may or may not be included in advertisements, based on a tradeoff
 between usability, efficiency and privacy.
 
-#### Functional Requirements: Remote Playback API
+### Functional Requirements: Remote Playback API
 
 [Issue #3](https://github.com/webscreens/openscreenprotocol/issues/3): Add requirements for Remote Playback API
 

templates/discovery.md

@@ -0,0 +1,69 @@
+# Protocol name
+
+Describe the discovery protocol at a high level here.
+
+# Design and specification
+
+Add links to specifications and design docs.
+
+# Presentation API functionality
+
+Describe how the discovery protocol meets
+[functional requirements for the Presentation API](../requirements.md#presentation-display-availability)
+for presentation display availability.
+
+# Remote Playback API functionality
+
+Describe how the discovery protocol meets functional requirements for the Remote
+Playback API.
+
+**TODO:** Fill in when Remote Playback equirements are known.
+See [Issue #3](https://github.com/webscreens/openscreenprotocol/issues/3).
+
+# Reliability
+
+Data describing reliability in different network requirements.
+
+# Latency of device discovery / device removal
+
+Data on the latency of discovering a new display device added to the network, or
+discovering that a display device was disconnected from the network.
+
+# Network and power efficiency
+
+Any data about power and network overhead.
+
+# Ease of implementation / deployment
+
+Including availability of open source implementations.
+
+# IPv4 and IPv6 support
+
+# Hardware requirements
+
+The minimum specifications needed to use the discovery protocol, and whether
+the devices in [Sample Device Specifications](../device_specs.md) are
+sufficient.
+
+# Standardization status
+
+Describe standardization process, timeline, and link to working group's IPR
+policy, if any.
+
+# Privacy
+
+What device or application information is exposed to network observers by the
+discovery protocol?
+
+# Security
+
+Describe any impact on the security of the controller or presentation display,
+including threats and potential mitigations.
+
+# User experience
+
+Describe any specific impact on
+meeting [user experience requirements](../requirements.md#req-nf3-ux) not covered
+by the points above.
+
+# Notes

templates/transport.md

@@ -1,8 +1,8 @@
-# Transport Name
+# Transport name
 
 Describe tranport at a high level here.
 
-# Design and Specification
+# Design and specification
 
 Add links to specifications and design docs.
 
@@ -21,24 +21,23 @@ See [Issue #3](https://github.com/webscreens/openscreenprotocol/issues/3).
 
 # Reliability
 
-Data describing reliability in different network requirements.
+Data describing reliability in different network environments.
 
 # Latency to establish a new connection
 
 Data on connection establishment latency.
 
-# Latency to transmit a messages
+# Latency to transmit messages
 
 Data on latency of message transmission.
 
-# Ease of implementation / deployment
+# Network and power efficiency
 
-Including availability of open source implementations.
+Any data about power and network overhead.
 
-# Privacy
+# Ease of implementation / deployment
 
-What device or application information is exposed to network observers by the
-transport?
+Including availability of open source implementations.
 
 # IPv4 and IPv6 support
 
@@ -47,21 +46,22 @@ transport?
 The minimum specifications needed to use the transport, and whether the devices
 in [Sample Device Specifications](../device_specs.md) are sufficient.
 
-# Network and power efficiency
-
-Any data about power and network overhead.
-
 # Standardization status
 
 Describe standardization process, timeline, and link to working group's IPR
 policy, if any.
 
+# Privacy
+
+What device or application information is exposed to network observers by the
+transport?
+
 # Security
 
 Describe security architecture and what encryption and authentication mechanisms
 are supported.
 
-# User Experience
+# User experience
 
 Describe any specific impact on
 meeting [user experience requirements](../requirements.md#req-nf3-ux) not covered