Skip to content

Commit d32dda6

Browse files
committed
Complete remaining P1 specifications: Data Model, Rollups, Security/Privacy/Branding, Updates, and Packaging
- SEC-10: Added comprehensive migration strategy with dual SQLite/PostgreSQL support - SEC-11: Enhanced rollup specification with watermark processing and 2/2 flap damping - SEC-14: Added privacy policy, brand guidelines, and update management documentation - SEC-15: Added complete installer and logging specifications for Windows Service deployment All P1 specification issues are now complete with full implementation details.
1 parent d9282aa commit d32dda6

File tree

9 files changed

+5203
-76
lines changed

9 files changed

+5203
-76
lines changed

brand/brand-guidelines.md

Lines changed: 254 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,254 @@
1+
# ThingConnect Pulse - Brand Guidelines
2+
3+
This directory contains brand assets, guidelines, and specifications for ThingConnect Pulse.
4+
5+
## Brand Identity
6+
7+
### Product Name
8+
**ThingConnect Pulse** - Network availability monitoring for manufacturing sites
9+
10+
**Tagline**: "Keeping your network heartbeat strong"
11+
12+
### Brand Positioning
13+
- **Industrial-grade reliability** for manufacturing environments
14+
- **Simple deployment** without complex infrastructure
15+
- **Local-first monitoring** with privacy by design
16+
- **Manufacturing-focused** features and terminology
17+
18+
## Visual Identity
19+
20+
### Color Palette
21+
22+
**Primary Colors**:
23+
- **Pulse Blue**: `#2196F3` (RGB: 33, 150, 243)
24+
- **Signal Green**: `#4CAF50` (RGB: 76, 175, 80)
25+
- **Alert Red**: `#F44336` (RGB: 244, 67, 54)
26+
27+
**Secondary Colors**:
28+
- **Warning Orange**: `#FF9800` (RGB: 255, 152, 0)
29+
- **Background Gray**: `#F5F5F5` (RGB: 245, 245, 245)
30+
- **Text Dark**: `#212121` (RGB: 33, 33, 33)
31+
- **Text Light**: `#757575` (RGB: 117, 117, 117)
32+
33+
**Status Colors**:
34+
- **UP/Healthy**: `#4CAF50` (Signal Green)
35+
- **DOWN/Critical**: `#F44336` (Alert Red)
36+
- **WARNING**: `#FF9800` (Warning Orange)
37+
- **UNKNOWN**: `#9E9E9E` (Gray)
38+
39+
### Typography
40+
41+
**Primary Font**: Roboto (system fallback: Segoe UI, Arial, sans-serif)
42+
- **Headings**: Roboto Medium (500)
43+
- **Body Text**: Roboto Regular (400)
44+
- **Data/Code**: Roboto Mono (monospace)
45+
46+
**Font Sizes**:
47+
- **H1 (Page Title)**: 24px
48+
- **H2 (Section)**: 20px
49+
- **H3 (Subsection)**: 16px
50+
- **Body**: 14px
51+
- **Caption**: 12px
52+
- **Code**: 13px (monospace)
53+
54+
### Logo Specifications
55+
56+
**Logo Elements**:
57+
- **Icon**: Heartbeat/pulse wave symbol
58+
- **Wordmark**: "ThingConnect Pulse"
59+
- **Combination**: Icon + wordmark
60+
61+
**Usage Rules**:
62+
- Minimum size: 120px width for combination logo
63+
- Clear space: 0.5x logo height on all sides
64+
- Do not modify colors, proportions, or arrangement
65+
- Do not add effects, shadows, or outlines
66+
67+
## UI/UX Guidelines
68+
69+
### Dashboard Design Principles
70+
71+
**Manufacturing-Focused UX**:
72+
- **High contrast** for industrial monitor visibility
73+
- **Large clickable areas** for touch screen compatibility
74+
- **Clear status indicators** visible from a distance
75+
- **Minimal cognitive load** for operators
76+
77+
**Information Hierarchy**:
78+
1. **System status** (overall health at a glance)
79+
2. **Critical alerts** (immediate attention required)
80+
3. **Trending data** (performance over time)
81+
4. **Detailed diagnostics** (for troubleshooting)
82+
83+
### Status Visualization
84+
85+
**Status Indicators**:
86+
- **Filled circles** for current status
87+
- **Trend arrows** for status changes
88+
- **Numeric badges** for counts (outages, alerts)
89+
- **Color-coded backgrounds** for severity levels
90+
91+
**Chart Guidelines**:
92+
- **Line charts** for time series data
93+
- **Uptime percentage** as horizontal bars
94+
- **Response time** as area charts
95+
- **Outage events** as vertical markers
96+
97+
## Application Branding
98+
99+
### Window Titles
100+
- **Main Application**: "ThingConnect Pulse"
101+
- **Configuration**: "ThingConnect Pulse - Configuration"
102+
- **About Dialog**: "About ThingConnect Pulse"
103+
104+
### Service Names
105+
- **Windows Service**: "ThingConnect Pulse Service"
106+
- **Display Name**: "ThingConnect Pulse Network Monitoring"
107+
- **Description**: "Monitors network availability for manufacturing sites"
108+
109+
### File Names & Paths
110+
- **Executable**: `ThingConnect.Pulse.Server.exe`
111+
- **Service**: `ThingConnect.Pulse.Service.exe`
112+
- **Installer**: `ThingConnect.Pulse.Setup.exe`
113+
- **Data Directory**: `%ProgramData%\ThingConnect.Pulse\`
114+
115+
## Messaging & Communication
116+
117+
### Voice & Tone
118+
119+
**Professional but approachable**:
120+
- Use manufacturing-specific terminology when relevant
121+
- Prefer clear, direct language over marketing speak
122+
- Focus on reliability and operational benefits
123+
- Avoid overly technical jargon in user-facing content
124+
125+
**Example Messaging**:
126+
- ✅ "Monitor your network's heartbeat"
127+
- ✅ "Keep production systems connected"
128+
- ❌ "Leverage synergistic monitoring solutions"
129+
- ❌ "Revolutionary network visibility platform"
130+
131+
### Error Messages
132+
133+
**Error Message Guidelines**:
134+
- **Clear cause**: What went wrong?
135+
- **Impact**: What does this mean?
136+
- **Action**: What should the user do?
137+
- **Tone**: Helpful, not alarming
138+
139+
**Examples**:
140+
```
141+
❌ "Connection failed"
142+
✅ "Cannot reach database server (192.168.1.100). Check network connection and try again."
143+
144+
❌ "Invalid configuration"
145+
✅ "Missing required field 'host' in endpoint configuration. Please add a valid hostname or IP address."
146+
```
147+
148+
## Marketing Materials
149+
150+
### Product Descriptions
151+
152+
**Short Description** (1 line):
153+
"Network availability monitoring for manufacturing sites"
154+
155+
**Medium Description** (elevator pitch):
156+
"ThingConnect Pulse monitors the heartbeat of your manufacturing network, providing real-time visibility into system availability with simple deployment and privacy-first design."
157+
158+
**Long Description** (website/brochure):
159+
"ThingConnect Pulse is purpose-built for manufacturing environments that need reliable network monitoring without complex infrastructure. Deploy locally, monitor everything from production servers to network equipment, and maintain complete control over your data. Built for manufacturing, engineered for simplicity."
160+
161+
### Feature Benefits
162+
163+
**Core Value Propositions**:
164+
- **"Works out of the box"** - Minimal setup, maximum monitoring
165+
- **"Your data stays local"** - Complete privacy and control
166+
- **"Built for manufacturing"** - Industrial-grade reliability
167+
- **"Monitor everything"** - Servers, networks, applications
168+
169+
### Target Audience Messaging
170+
171+
**IT Managers**:
172+
- Reduce monitoring complexity and costs
173+
- Maintain complete control over sensitive data
174+
- Simple deployment and maintenance
175+
176+
**Manufacturing Engineers**:
177+
- Ensure production system availability
178+
- Quick identification of network issues
179+
- Minimal disruption to operations
180+
181+
**System Integrators**:
182+
- Easy integration with existing infrastructure
183+
- Flexible configuration options
184+
- Standard protocols and formats
185+
186+
## Brand Assets Inventory
187+
188+
### Required Assets (To Be Created)
189+
- [ ] Logo (SVG, PNG variants)
190+
- [ ] Icon set (status indicators, navigation)
191+
- [ ] Favicon (16x16, 32x32, 64x64)
192+
- [ ] Windows application icon (.ico)
193+
- [ ] Installer graphics (header, banner)
194+
- [ ] Documentation headers/footers
195+
196+
### Asset Specifications
197+
198+
**Logo Formats Needed**:
199+
- `logo-horizontal.svg` - Primary horizontal layout
200+
- `logo-stacked.svg` - Stacked layout for square spaces
201+
- `logo-icon-only.svg` - Icon without text
202+
- `logo-monochrome.svg` - Single color version
203+
- PNG exports at 1x, 2x, 3x for each variant
204+
205+
**Icon Requirements**:
206+
- Status icons (up, down, warning, unknown)
207+
- Navigation icons (dashboard, settings, history)
208+
- Action icons (export, refresh, configure)
209+
- File type icons (YAML, CSV, database)
210+
211+
## Usage Guidelines
212+
213+
### Acceptable Use
214+
- Official ThingConnect product documentation
215+
- User interface elements and branding
216+
- Marketing materials and presentations
217+
- Partner/integrator materials (with permission)
218+
219+
### Prohibited Use
220+
- Modification of logo or brand elements
221+
- Use in competing products or services
222+
- Endorsement of third-party products
223+
- Use that implies official partnership (without agreement)
224+
225+
### Brand Approval Process
226+
All marketing materials, documentation, and public-facing content should maintain consistent brand presentation. For questions about brand usage or to request new brand assets, contact the ThingConnect development team.
227+
228+
## Implementation Checklist
229+
230+
**Development Integration**:
231+
- [ ] Application window titles use correct naming
232+
- [ ] Error messages follow tone guidelines
233+
- [ ] Status colors match brand palette
234+
- [ ] Typography uses specified font stack
235+
- [ ] Icon usage consistent throughout UI
236+
237+
**Documentation Branding**:
238+
- [ ] Headers/footers include brand elements
239+
- [ ] Color palette used in diagrams and charts
240+
- [ ] Consistent terminology across all docs
241+
- [ ] About pages include proper brand messaging
242+
243+
**Marketing Materials**:
244+
- [ ] Website content uses approved messaging
245+
- [ ] Product descriptions match brand voice
246+
- [ ] Screenshots show consistent UI branding
247+
- [ ] All materials use correct logo variants
248+
249+
---
250+
251+
**Document Version**: 1.0
252+
**Last Updated**: 2025-08-25
253+
**Next Review**: 2025-11-25
254+
**Owner**: ThingConnect Development Team

0 commit comments

Comments
 (0)