smart-documentation-strategy
Version:
AI-powered documentation maintenance with visual staleness indicators, team collaboration, and Git integration
148 lines (104 loc) • 4.25 kB
Markdown
# Smart Documentation Strategy
> AI-powered documentation maintenance with visual staleness indicators, team collaboration, and Git integration.
[](https://marketplace.visualstudio.com/items?itemName=Vaeshkar.smart-documentation-strategy)
[](https://open-vsx.org/extension/vaeshkar/smart-documentation-strategy)
[](https://marketplace.visualstudio.com/items?itemName=Vaeshkar.smart-documentation-strategy)
Never let your documentation go stale again! This extension provides real-time visual feedback about documentation freshness directly in your VS Code editor.
## 🚀 Quick Start
1. **Install the extension** from VS Code Marketplace
2. **Open any markdown file** with timestamps
3. **See instant visual feedback** about document staleness
4. **Check status bar** for ownership and staleness info
5. **Use Command Palette** → "SDS: Check Documentation Staleness"
## 📸 Screenshots
### Status Bar Integration
The extension shows document status, age, and ownership directly in your status bar:
```
✅ SDS: current | alice, bob
⚠️ SDS: stale (45d) | charlie
❓ SDS: unknown
```
### Visual Highlighting
Timestamp lines are highlighted with color-coding:
- 🟢 **Green**: Current documentation (< 30 days)
- 🔴 **Red**: Stale documentation (> 30 days)
- ❓ **Gray**: Unknown status
### Team Features
See document ownership and collaboration info:
```markdown
owners: ["alice", "bob"]
reviewers: ["charlie", "diana"]
priority: high
lastUpdated: 2025-09-23
```
## Features
### 🎯 **Real-time Staleness Detection**
- **Visual indicators** for stale documentation timestamps
- **Status bar integration** showing document status and ownership
- **Hover tooltips** with detailed staleness information
- **Automatic refresh** when switching between files
### 👥 **Team Integration**
- **Owner display** in status bar and tooltips
- **Team report generation** with one command
- **Priority indicators** for high/medium/low priority docs
- **Git integration** showing last modification authors
### 🎨 **Visual Feedback**
- **Color-coded highlights** for timestamp lines
- **Customizable colors** via VS Code themes
- **Overview ruler indicators** for quick document scanning
- **Status bar icons** for immediate feedback
## Commands
- **SDS: Check Documentation Staleness** - Analyze current document
- **SDS: Refresh Staleness Indicators** - Update visual indicators
- **SDS: Show Team Documentation Report** - Generate team overview
## Configuration
```json
{
"sds.enableIndicators": true,
"sds.stalenessThreshold": 30,
"sds.showInStatusBar": true
}
```
## Installation
1. Install from VS Code Marketplace (coming soon)
2. Or install locally:
```bash
cd packages/sds-vscode
npm run package
code --install-extension sds-vscode-1.0.0.vsix
```
## Usage
1. Open any markdown file
2. The extension automatically detects timestamps
3. Visual indicators appear for stale content
4. Check status bar for ownership and staleness info
5. Use commands for detailed analysis
## Requirements
- VS Code 1.74.0 or higher
- SDS configuration file (`.sdsrc.json`) in your workspace
## Supported Timestamp Formats
- `**Last Updated**: 2025-09-23`
- `Last Updated: September 23, 2025`
- Frontmatter: `lastUpdated: 2025-09-23`
- And many more flexible formats
## Team Features
Configure document ownership in `.sdsrc.json`:
```json
{
"documentOwners": {
"api": ["alice", "bob"],
"deployment": ["charlie"]
}
}
```
## Visual Indicators
- 🟢 **Green highlight**: Current documentation
- 🔴 **Red highlight**: Stale documentation
- ❓ **Status bar**: Shows ownership and staleness
- 📊 **Team report**: Complete team documentation overview
## Contributing
This extension is part of the SDS toolkit. See the main repository for contribution guidelines.
## License
MIT - See LICENSE file for details.