Skip to content

Commit 45dd2cb

Browse files
salacosteclaude
andcommitted
docs: replace Epic 5B MCP Server stories with Epic 5 Documentation stories
Remove old conflicting MCP Server stories (5.1-5.3) and add complete Epic 5 Documentation Enhancement story set (11 stories) matching EPIC_5_DOCUMENTATION.md. Changes: - Removed: 5.1.mcp-server-foundation.md (old MCP Server epic) - Removed: 5.2.comprehensive-tool-suite.md (old MCP Server epic) - Removed: 5.3.production-hardening.md (old MCP Server epic) - Added: 11 Epic 5 Documentation stories (5.1-5.11) - Community foundation files - Documentation structure reorganization - Quickstart guide & onboarding - API reference generation - Complete example suite - Best practices guide - Performance tuning guide - Troubleshooting guide - FAQ & glossary - Russian documentation - Documentation website deployment 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent ed2a997 commit 45dd2cb

14 files changed

Lines changed: 5873 additions & 2101 deletions

docs/stories/5.1.community-foundation-files.md

Lines changed: 546 additions & 0 deletions
Large diffs are not rendered by default.

docs/stories/5.1.mcp-server-foundation.md

Lines changed: 0 additions & 476 deletions
This file was deleted.
Lines changed: 290 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,290 @@
1+
# Story 5.10: Russian Documentation Translation
2+
3+
---
4+
5+
## Status
6+
7+
**To Do**
8+
9+
---
10+
11+
## Story
12+
13+
**As a** Russian-speaking developer in Wildberries' primary market,
14+
**I want** critical documentation translated to Russian,
15+
**so that** I can learn and use the SDK in my native language.
16+
17+
---
18+
19+
## Acceptance Criteria
20+
21+
1. Quickstart guide translated to Russian (docs/ru/getting-started/quickstart.md)
22+
2. README.md core sections translated to Russian (docs/ru/README.md)
23+
3. Tutorial 1 (Product Catalog Sync) translated to Russian
24+
4. Tutorial 2 (Order Fulfillment) translated to Russian
25+
5. Translation reviewed by native Russian speaker
26+
6. Technical terminology consistency validated
27+
7. All code examples work with Russian comments
28+
8. Links between Russian and English docs working
29+
9. Language switcher documented in main README
30+
10. Translation quality meets professional standards (if paid service used)
31+
32+
---
33+
34+
## Tasks / Subtasks
35+
36+
- [ ] **Task 1: Decide Translation Strategy** (AC: 10)
37+
- [ ] Option A: Professional translation service ($2-5K, 2-3 weeks)
38+
- [ ] Option B: Community-driven translation (free, 4-8 weeks)
39+
- [ ] Option C: Machine translation + native review (hybrid)
40+
- [ ] Document decision rationale
41+
- [ ] Allocate budget if professional service chosen
42+
43+
- [ ] **Task 2: Translate Quickstart Guide** (AC: 1, 7)
44+
- [ ] Translate docs/getting-started/quickstart.md to Russian
45+
- [ ] Create docs/ru/getting-started/quickstart.md
46+
- [ ] Translate all explanatory text
47+
- [ ] Add Russian comments to code examples
48+
- [ ] Preserve code functionality
49+
- [ ] Test translated guide with Russian-speaking user
50+
51+
- [ ] **Task 3: Translate README Core Sections** (AC: 2)
52+
- [ ] Create docs/ru/README.md
53+
- [ ] Translate: Project overview, features, installation
54+
- [ ] Translate: Quick start example
55+
- [ ] Translate: Documentation navigation
56+
- [ ] Translate: Contributing section
57+
- [ ] Keep code examples functional
58+
- [ ] Link to English docs for detailed content
59+
60+
- [ ] **Task 4: Translate Tutorial 1** (AC: 3)
61+
- [ ] Translate Product Catalog Sync tutorial
62+
- [ ] Create docs/ru/getting-started/tutorials/product-catalog-sync.md
63+
- [ ] Translate step-by-step instructions
64+
- [ ] Add Russian code comments
65+
- [ ] Translate expected output
66+
- [ ] Verify code works
67+
68+
- [ ] **Task 5: Translate Tutorial 2** (AC: 4)
69+
- [ ] Translate Order Fulfillment tutorial
70+
- [ ] Create docs/ru/getting-started/tutorials/order-fulfillment.md
71+
- [ ] Translate workflow descriptions
72+
- [ ] Add Russian code comments
73+
- [ ] Translate state transition explanations
74+
- [ ] Verify code works
75+
76+
- [ ] **Task 6: Native Speaker Review** (AC: 5)
77+
- [ ] Find qualified native Russian speaker
78+
- [ ] Review all translations for accuracy
79+
- [ ] Check grammar and readability
80+
- [ ] Verify technical terminology
81+
- [ ] Incorporate feedback
82+
- [ ] Final approval
83+
84+
- [ ] **Task 7: Validate Technical Terminology** (AC: 6)
85+
- [ ] Create Russian glossary
86+
- [ ] Standardize translations of technical terms
87+
- [ ] Ensure consistency across all documents
88+
- [ ] Review industry-standard terminology
89+
- [ ] Document translation choices
90+
91+
- [ ] **Task 8: Link Russian and English Docs** (AC: 8)
92+
- [ ] Add language switcher to each page
93+
- [ ] Link Russian docs to English equivalents
94+
- [ ] Link English docs to Russian equivalents
95+
- [ ] Test all cross-language links
96+
- [ ] Verify navigation works
97+
98+
- [ ] **Task 9: Document Language Switcher** (AC: 9)
99+
- [ ] Add language selection to main README
100+
- [ ] Document how to access Russian docs
101+
- [ ] Add language badges
102+
- [ ] Update contribution guide for translations
103+
104+
---
105+
106+
## Dev Notes
107+
108+
### Translation Strategy Comparison
109+
110+
| Approach | Cost | Time | Quality | Maintenance |
111+
|----------|------|------|---------|-------------|
112+
| **Professional Service** | $2-5K | 2-3 weeks | Excellent | One-time |
113+
| **Community-Driven** | Free | 4-8 weeks | Good | Ongoing |
114+
| **Machine + Review** | $500-1K | 1-2 weeks | Good | One-time |
115+
116+
**Recommendation:** Machine translation + native speaker review (hybrid approach)
117+
- Cost-effective ($500-1K)
118+
- Fast turnaround (1-2 weeks)
119+
- Good quality (native review ensures accuracy)
120+
- Scalable (can expand to other languages)
121+
122+
### Russian Documentation Structure
123+
124+
```
125+
docs/ru/
126+
├── README.md # Translated README
127+
├── getting-started/
128+
│ ├── quickstart.md # Translated quickstart
129+
│ └── tutorials/
130+
│ ├── product-catalog-sync.md
131+
│ └── order-fulfillment.md
132+
└── CONTRIBUTING.md # Translation guidelines
133+
```
134+
135+
### Quickstart Translation Example
136+
137+
**English:**
138+
```markdown
139+
# Quickstart Guide
140+
141+
Get started with the Wildberries TypeScript SDK in 5 minutes.
142+
143+
## Step 1: Installation
144+
145+
Install the SDK via npm:
146+
147+
\`\`\`bash
148+
npm install wb-api-sdk
149+
\`\`\`
150+
```
151+
152+
**Russian:**
153+
```markdown
154+
# Краткое руководство
155+
156+
Начните работу с Wildberries TypeScript SDK за 5 минут.
157+
158+
## Шаг 1: Установка
159+
160+
Установите SDK через npm:
161+
162+
\`\`\`bash
163+
npm install wb-api-sdk
164+
\`\`\`
165+
```
166+
167+
### Code Example with Russian Comments
168+
169+
**English:**
170+
```typescript
171+
// Initialize SDK with your API key
172+
const sdk = new WildberriesSDK({
173+
apiKey: process.env.WB_API_KEY!
174+
});
175+
176+
// Fetch parent categories
177+
const categories = await sdk.products.getParentCategories();
178+
console.log('Categories:', categories.data);
179+
```
180+
181+
**Russian:**
182+
```typescript
183+
// Инициализируйте SDK с вашим API ключом
184+
const sdk = new WildberriesSDK({
185+
apiKey: process.env.WB_API_KEY!
186+
});
187+
188+
// Получите родительские категории
189+
const categories = await sdk.products.getParentCategories();
190+
console.log('Категории:', categories.data);
191+
```
192+
193+
### Technical Terminology Glossary
194+
195+
| English | Russian | Notes |
196+
|---------|---------|-------|
197+
| API key | API ключ | Standard translation |
198+
| Module | Модуль | Standard translation |
199+
| Rate limit | Ограничение скорости / Лимит запросов | Use "Лимит запросов" |
200+
| Fulfillment | Фулфилмент | Keep English term (industry standard) |
201+
| Product card | Карточка товара | Wildberries-specific |
202+
| Order | Заказ | Standard translation |
203+
| SKU | SKU / Артикул | Use "Артикул" (more common in Russia) |
204+
| Barcode | Штрихкод | Standard translation |
205+
206+
### Language Switcher Implementation
207+
208+
**In README.md:**
209+
```markdown
210+
# Wildberries TypeScript SDK
211+
212+
[English](README.md) | [Русский](docs/ru/README.md)
213+
214+
Full-featured TypeScript SDK for Wildberries Marketplace API...
215+
```
216+
217+
**In Russian docs:**
218+
```markdown
219+
# Wildberries TypeScript SDK
220+
221+
[English](../../README.md) | [Русский](README.md)
222+
223+
Полнофункциональный TypeScript SDK для API Wildberries Marketplace...
224+
```
225+
226+
### Translation Quality Checklist
227+
228+
**Native Speaker Review:**
229+
- [ ] Grammar and spelling correct
230+
- [ ] Natural, fluent Russian
231+
- [ ] Technical terminology appropriate
232+
- [ ] Consistent with industry standards
233+
- [ ] Cultural appropriateness
234+
- [ ] Clear and understandable
235+
236+
**Technical Validation:**
237+
- [ ] Code examples work
238+
- [ ] Links functional
239+
- [ ] Terminology consistent
240+
- [ ] Formatting preserved
241+
- [ ] Examples culturally appropriate
242+
243+
### Future Internationalization
244+
245+
**Other Languages to Consider:**
246+
- Ukrainian (Україна) - 20% of Wildberries sellers
247+
- Kazakh (Қазақ) - 10% of Wildberries sellers
248+
- Belarusian (Беларуская) - 5% of Wildberries sellers
249+
250+
**Internationalization Framework:**
251+
- Use i18n-friendly structure
252+
- Separate content from code
253+
- Document translation process
254+
- Enable community contributions
255+
256+
[Source: EPIC_5_DOCUMENTATION.md i18n requirements]
257+
258+
### Validation Checklist
259+
260+
Before marking this story complete, verify:
261+
- ✅ Translation strategy decided and documented
262+
- ✅ Quickstart guide translated to Russian
263+
- ✅ README core sections translated
264+
- ✅ Tutorial 1 (Product Catalog) translated
265+
- ✅ Tutorial 2 (Order Fulfillment) translated
266+
- ✅ Native speaker review completed
267+
- ✅ Technical terminology consistent
268+
- ✅ All code examples work
269+
- ✅ Language switcher working
270+
- ✅ Translation quality approved
271+
272+
---
273+
274+
## Change Log
275+
276+
| Date | Version | Description | Author |
277+
|------|---------|-------------|--------|
278+
| 2025-10-26 | 1.0 | Initial story draft for Epic 5B | Sarah (Product Owner) |
279+
280+
---
281+
282+
## Dev Agent Record
283+
284+
*This section will be populated by the development agent during implementation*
285+
286+
---
287+
288+
## QA Results
289+
290+
*To be filled by QA*

0 commit comments

Comments
 (0)