Skip to content

Commit a5e0ef5

Browse files
committed
feat(ui): automatically inject objective letter badges
- Add JavaScript to automatically inject letter badges when letter_prefix is present in frontmatter - Remove manual HTML badge code from all 13 objective pages - Add letter_prefix field to frontmatter of objective pages - Update CSS for standalone badge styling with reduced spacing - Expose letter_prefix metadata to JavaScript via content template - Add objective-badges.js to mkdocs.yml extra_javascript This maintains visual consistency while keeping markdown clean and improving SEO by removing letter prefixes from H1 headings.
1 parent 6de5e35 commit a5e0ef5

18 files changed

+1131
-561
lines changed

SITE_REVIEW.md

Lines changed: 371 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,371 @@
1+
# Site Review & Recommendations for method.ekgf.org
2+
3+
**Review Date:** January 2025
4+
**Reviewer:** AI Assistant
5+
**Site:** https://method.ekgf.org
6+
7+
## Executive Summary
8+
9+
The Use Case Tree Method documentation site is well-structured with
10+
good technical foundations. The site uses Material for MkDocs with
11+
proper SEO infrastructure, responsive design, and excellent diagram
12+
support. However, there are several areas for improvement,
13+
particularly around content completeness, SEO optimization, and user
14+
experience enhancements.
15+
16+
## Overall Assessment
17+
18+
**Strengths:**
19+
20+
- ✅ Excellent technical setup (MkDocs, Material theme, proper SEO
21+
infrastructure)
22+
- ✅ Good navigation structure with awesome-pages plugin
23+
- ✅ Well-organized content hierarchy (intro → objective → concept →
24+
process → vocab)
25+
- ✅ Good use of audience-specific tabs (Business & Management vs Data
26+
& Tech)
27+
- ✅ Comprehensive FAQ section
28+
- ✅ Good diagram support (PlantUML, Mermaid)
29+
- ✅ Proper structured data (JSON-LD) implementation
30+
31+
**Areas for Improvement:**
32+
33+
- ⚠️ Content completeness (6 pages with TODOs)
34+
- ⚠️ SEO optimization (missing dates on concept pages)
35+
- ⚠️ Internal linking could be more systematic
36+
- ⚠️ Some pages lack related content sections
37+
38+
---
39+
40+
## Priority 1: Critical Issues (Fix Immediately)
41+
42+
### 1.1 Complete TODO Content
43+
44+
**Issue:** 6 pages have incomplete content marked with TODOs:
45+
46+
1. **`docs/objective/strategic-usecases.md`** - Only has a TODO
47+
comment, no actual content
48+
2. **`docs/vocab/silo.md`** - Only has a TODO, no content
49+
3. **`docs/vocab/positive-learning.md`** - Only has a TODO and a link,
50+
no content
51+
4. **`docs/process/build/design.md`** - Summary section has "TODO"
52+
instead of actual summary
53+
5. **`docs/process/run/operate.md`** - "## Audience" section has TODO
54+
6. **`docs/process/run/optimize.md`** - "## Audience" section has TODO
55+
56+
**Impact:** High - Incomplete content hurts user experience and SEO
57+
58+
**Recommendation:** Complete all TODO sections with proper content.
59+
For the strategic use cases page, this is particularly important as
60+
it's a key objective.
61+
62+
---
63+
64+
## Priority 2: SEO Improvements (High Impact)
65+
66+
### 2.1 Add `date_published` to Concept Pages
67+
68+
**Issue:** Concept pages are missing `date_published` fields, which
69+
Google uses as a freshness signal.
70+
71+
**Files Affected:**
72+
73+
- `docs/concept/use-case.md`
74+
- `docs/concept/use-case-tree.md`
75+
- `docs/concept/ontology.md`
76+
- `docs/concept/data-product.md`
77+
- `docs/concept/persona.md`
78+
- `docs/concept/story.md`
79+
- `docs/concept/outcome.md`
80+
- `docs/concept/workflow.md`
81+
- `docs/concept/concept.md`
82+
- `docs/concept/term.md`
83+
84+
**Recommendation:** Add `date_published: "2022-01-01"` (or actual
85+
publication date) to frontmatter of all concept pages.
86+
87+
### 2.2 Add Related Content Sections
88+
89+
**Issue:** Not all pages have "Related Content" sections, which
90+
improves internal linking and helps users discover related
91+
information.
92+
93+
**Recommendation:** Add a "Related Content" section to all concept and
94+
objective pages that don't already have one. This should include:
95+
96+
- Related concepts
97+
- Related objectives
98+
- Related process steps
99+
- Related vocabulary terms
100+
101+
**Template:**
102+
103+
```markdown
104+
## Related Content
105+
106+
- **[Related Concept](link.md)** - Brief explanation of relationship
107+
- **[Related Objective](link.md)** - Brief explanation of relationship
108+
- **[Related Process Step](link.md)** - Brief explanation of
109+
relationship
110+
```
111+
112+
### 2.3 Improve Meta Descriptions
113+
114+
**Issue:** Some descriptions could be more compelling and
115+
action-oriented.
116+
117+
**Recommendation:** Review all descriptions to ensure they:
118+
119+
- Start with action words ("Learn", "Discover", "Get started")
120+
- Are 150-160 characters
121+
- Include specific benefits
122+
- Are compelling enough to click
123+
124+
**Example:** Current: "Enable interoperability across the
125+
enterprise..." Better: "Learn how to achieve enterprise-wide
126+
interoperability using the Use Case Tree Method. Practical guide to
127+
semantic standards and data integration."
128+
129+
---
130+
131+
## Priority 3: Content Quality Enhancements
132+
133+
### 3.1 Complete Summary Sections
134+
135+
**Issue:** `docs/process/build/design.md` has "TODO" in the summary
136+
section instead of an actual summary.
137+
138+
**Recommendation:** Replace TODO with a proper summary that describes
139+
what the Design phase accomplishes.
140+
141+
**Suggested Summary:**
142+
143+
```markdown
144+
<!--summary-start-->
145+
146+
_Design the EKG Platform architecture and use case specifications,
147+
organizing both technical platform design and business-focused use
148+
case designs._
149+
150+
<!--summary-end-->
151+
```
152+
153+
### 3.2 Add "What is..." Sections
154+
155+
**Issue:** Some pages could benefit from clearer introductory "What
156+
is..." sections for better search intent matching.
157+
158+
**Recommendation:** Ensure all concept pages have clear "What is
159+
[Concept]?" sections at the beginning, especially for users arriving
160+
from search engines.
161+
162+
### 3.3 Enhance Process Pages
163+
164+
**Issue:** Some process pages (operate.md, optimize.md) have
165+
incomplete "Audience" sections.
166+
167+
**Recommendation:** Complete the Audience sections with information
168+
about who should read these pages and why.
169+
170+
---
171+
172+
## Priority 4: User Experience Improvements
173+
174+
### 4.1 Add Breadcrumb Navigation Context
175+
176+
**Issue:** While Material for MkDocs provides breadcrumbs, some pages
177+
could benefit from more explicit navigation context.
178+
179+
**Recommendation:** Consider adding "Next Steps" or "Continue Reading"
180+
sections at the end of key pages to guide users through the
181+
documentation journey.
182+
183+
### 4.2 Improve Internal Linking
184+
185+
**Issue:** Internal linking exists but could be more systematic.
186+
187+
**Recommendation:**
188+
189+
- Add 3-5 internal links per page
190+
- Use descriptive anchor text (not "click here")
191+
- Link from high-traffic pages (homepage, intro) to important content
192+
- Create a "See Also" section on key pages
193+
194+
### 4.3 Add "Last Updated" Indicators
195+
196+
**Issue:** No visible indication of when content was last updated.
197+
198+
**Recommendation:** Consider adding `date_modified` fields and
199+
displaying "Last updated" indicators on pages. The
200+
git-revision-date-localized plugin is already configured, so this
201+
could be enabled.
202+
203+
---
204+
205+
## Priority 5: Technical Enhancements
206+
207+
### 5.1 Add Missing Schema Types
208+
209+
**Issue:** Some pages may benefit from more specific schema types.
210+
211+
**Recommendation:** Review schema types:
212+
213+
- Process pages should use `"HowTo"` (already done)
214+
- Concept pages should use `"Article"` (already done)
215+
- FAQ page uses `"FAQPage"` (good)
216+
- Consider `"Course"` or `"LearningResource"` for the overall method
217+
218+
### 5.2 Enhance Search Functionality
219+
220+
**Issue:** Search is functional but could be enhanced.
221+
222+
**Recommendation:**
223+
224+
- Ensure all important terms are in content (not just keywords)
225+
- Consider adding a glossary/index page
226+
- Add search aliases for common terms
227+
228+
### 5.3 Optimize Images
229+
230+
**Issue:** Some external images are used (Unsplash) which may have
231+
loading delays.
232+
233+
**Recommendation:** Consider downloading and hosting frequently-used
234+
images locally for better performance and reliability.
235+
236+
---
237+
238+
## Priority 6: Content Strategy
239+
240+
### 6.1 Add Case Studies or Examples
241+
242+
**Issue:** The method is described but lacks concrete examples or case
243+
studies.
244+
245+
**Recommendation:** Consider adding:
246+
247+
- Real-world examples of use cases
248+
- Before/after scenarios
249+
- Success stories (if available)
250+
- Common patterns and anti-patterns
251+
252+
### 6.2 Create Getting Started Guide
253+
254+
**Issue:** While there's an intro page, a dedicated "Getting Started"
255+
guide could help new users.
256+
257+
**Recommendation:** Create a step-by-step "Getting Started" guide that
258+
walks users through:
259+
260+
1. Understanding the method
261+
2. Key concepts to learn first
262+
3. Recommended reading order
263+
4. Next steps
264+
265+
### 6.3 Add Visual Learning Aids
266+
267+
**Issue:** While diagrams exist, more visual aids could help
268+
understanding.
269+
270+
**Recommendation:** Consider adding:
271+
272+
- Flowcharts for the process
273+
- Decision trees
274+
- Comparison tables (e.g., Use Case Tree Method vs other approaches)
275+
- Infographics for key concepts
276+
277+
---
278+
279+
## Implementation Roadmap
280+
281+
### Week 1: Critical Fixes
282+
283+
- [ ] Complete TODO content in strategic-usecases.md
284+
- [ ] Complete TODO content in silo.md
285+
- [ ] Complete TODO content in positive-learning.md
286+
- [ ] Fix design.md summary section
287+
288+
### Week 2: SEO Improvements
289+
290+
- [ ] Add date_published to all 10 concept pages
291+
- [ ] Add related content sections to all concept pages
292+
- [ ] Add related content sections to remaining objective pages
293+
- [ ] Review and improve meta descriptions for top 20 pages
294+
295+
### Week 3: Content Quality
296+
297+
- [ ] Complete Audience sections in operate.md and optimize.md
298+
- [ ] Enhance internal linking throughout site
299+
- [ ] Add "What is..." sections where missing
300+
- [ ] Review and improve all summary sections
301+
302+
### Week 4: UX Enhancements
303+
304+
- [ ] Add "Next Steps" sections to key pages
305+
- [ ] Create getting started guide
306+
- [ ] Add last updated indicators
307+
- [ ] Optimize images
308+
309+
### Ongoing: Content Strategy
310+
311+
- [ ] Add case studies/examples
312+
- [ ] Create visual learning aids
313+
- [ ] Build backlinks from related sites
314+
- [ ] Regular content updates
315+
316+
---
317+
318+
## Metrics to Track
319+
320+
After implementing improvements, track:
321+
322+
- **Search Console Metrics:**
323+
- Impressions (target: 10x increase in 3 months)
324+
- Clicks (target: 5% CTR)
325+
- Average position (target: top 20 for key terms)
326+
- **User Engagement:**
327+
328+
- Time on page
329+
- Bounce rate
330+
- Pages per session
331+
- Scroll depth
332+
333+
- **Content Quality:**
334+
- Pages with incomplete content (target: 0)
335+
- Pages with related content sections (target: 100%)
336+
- Pages with date_published (target: 100%)
337+
338+
---
339+
340+
## Quick Wins Summary
341+
342+
1.**Complete TODOs** - Better user experience (in progress)
343+
2.**Add date_published** - Freshness signal for search (pending)
344+
3.**Add related content** - Better internal linking (pending)
345+
4.**Improve descriptions** - Better click-through rates (pending)
346+
347+
---
348+
349+
## Notes
350+
351+
- The site already has excellent technical foundations
352+
- SEO infrastructure is solid (sitemap, robots.txt, structured data)
353+
- The content structure is logical and well-organized
354+
- Most improvements are content-focused rather than technical
355+
- The SEO.md file already documents many of these issues - this review
356+
provides a comprehensive action plan
357+
358+
---
359+
360+
## Conclusion
361+
362+
The Use Case Tree Method documentation site is well-built with strong
363+
technical foundations. The main improvements needed are:
364+
365+
1. Content completeness (fix TODOs)
366+
2. SEO optimization (add dates to concept pages)
367+
3. Enhanced internal linking and related content sections
368+
4. Better user guidance (getting started, next steps)
369+
370+
With these improvements, the site should see significant improvements
371+
in search visibility and user engagement.

docs-overrides/partials/content.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@ <h1>{{ page.title | d(config.site_name, true)}}</h1>
4040
{% endif %}
4141

4242
<!-- Page content -->
43+
{% if page.meta.letter_prefix %}
44+
<script type="application/json" id="page-meta-letter-prefix">{{ page.meta.letter_prefix | tojson }}</script>
45+
{% endif %}
4346
{{ page.content }}
4447

4548
<!-- Source file information -->

0 commit comments

Comments
 (0)