wehub-resource-sync
0d3cb498a3
CI / Shell Format Check (push) Has been cancelled
CI / Check Ruby (3.4) (push) Has been cancelled
CI / CI Config (push) Has been cancelled
CI / Test on Node ${{ matrix.node }} and ${{ matrix.os }}${{ matrix.shard && format(' (shard {0}/3)', matrix.shard) || '' }} (push) Has been cancelled
CI / Build on Node ${{ matrix.node }} (push) Has been cancelled
CI / Style Check (push) Has been cancelled
CI / Generate Assets (push) Has been cancelled
CI / Check Python (3.14) (push) Has been cancelled
CI / Check Python (3.9) (push) Has been cancelled
CI / Build Docs (push) Has been cancelled
CI / Code Scan Action (push) Has been cancelled
CI / Site tests (push) Has been cancelled
CI / webui tests (push) Has been cancelled
CI / Run Integration Tests (push) Has been cancelled
CI / Run Smoke Tests (push) Has been cancelled
CI / Go Tests (push) Has been cancelled
CI / Share Test (push) Has been cancelled
CI / Redteam (Production API) (push) Has been cancelled
CI / Redteam (Staging API) (push) Has been cancelled
CI / GitHub Actions Lint (push) Has been cancelled
CI / Check Ruby (3.0) (push) Has been cancelled
release-please / release-please (push) Has been cancelled
release-please / build (push) Has been cancelled
release-please / publish-npm (push) Has been cancelled
release-please / publish-npm-backfill (push) Has been cancelled
release-please / docker (push) Has been cancelled
release-please / publish-code-scan-action (push) Has been cancelled
release-please / attest-code-scan-action (push) Has been cancelled
Deploy local.promptfoo.app / Deploy to Cloudflare Pages (push) Has been cancelled
Test and Publish Multi-arch Docker Image / test (push) Has been cancelled
Test and Publish Multi-arch Docker Image / build-docker-and-push-digests (map[digest-suffix:linux-amd64 platform:linux/amd64 runner:ubuntu-latest]) (push) Has been cancelled
Test and Publish Multi-arch Docker Image / build-docker-and-push-digests (map[digest-suffix:linux-arm64 platform:linux/arm64 runner:ubuntu-24.04-arm]) (push) Has been cancelled
Test and Publish Multi-arch Docker Image / merge-docker-digests (push) Has been cancelled
Test and Publish Multi-arch Docker Image / Attest Multi-arch Image (push) Has been cancelled
Validate Renovate Config / Validate Renovate Configuration (push) Has been cancelled
60 lines
2.2 KiB
Markdown
60 lines
2.2 KiB
Markdown
# Documentation Writing Guidelines for Red Team Docs
|
|
|
|
This file provides guidance for writing and maintaining documentation in the site/docs/red-team directory.
|
|
|
|
## Core Writing Principles
|
|
|
|
### User-Centric Approach
|
|
|
|
- Write for developers who want to quickly understand and implement
|
|
- Lead with what the user needs to accomplish, not exhaustive feature lists
|
|
- Prioritize practical examples over theoretical explanations
|
|
|
|
### Conciseness Over Verbosity
|
|
|
|
- Eliminate LLM-generated fluff and redundant explanations
|
|
- Remove substantially redundant criteria across pages
|
|
- Keep examples focused and actionable
|
|
- Use precise, technical language without unnecessary elaboration
|
|
|
|
### Content Organization
|
|
|
|
- **Main overview pages**: High-level comparison tables linking to specific pages
|
|
- **Individual plugin pages**: Focused content with specific examples
|
|
- **Configuration**: Quick start first, then advanced options
|
|
|
|
## Source Alignment
|
|
|
|
Keep plugin pages aligned with `src/redteam/plugins/`, strategy pages aligned with
|
|
`src/redteam/strategies/`, and result interpretation aligned with current scoring and
|
|
report output.
|
|
|
|
## Technical Writing Tips
|
|
|
|
- Use `jailbreak:meta` (single-turn), `jailbreak:hydra` (multi-turn), and `jailbreak:composite` as the default strategies, unless you have a specific need for other strategies
|
|
|
|
## SEO Best Practices
|
|
|
|
### Technical Depth with Keywords
|
|
|
|
- "How It Works" sections include technical processes and terminology
|
|
- Include brand terms naturally (e.g., "Promptfoo's evaluation framework")
|
|
- Use domain-specific keywords that developers actually search for
|
|
- Maintain clean prose while incorporating search-optimized language
|
|
|
|
### Content Format Guidelines
|
|
|
|
- Convert bullet-heavy sections to prose where appropriate for better readability
|
|
- Use tables for comparison and quick reference
|
|
- Structure FAQ answers as complete, standalone explanations
|
|
- Include cross-references to related concepts and plugins
|
|
|
|
## Anti-Patterns to Avoid
|
|
|
|
- Verbose, LLM-generated explanations
|
|
- Repetitive content across related pages
|
|
- Generic examples that don't illustrate the specific plugin
|
|
- Bullet point overuse where prose would be clearer
|
|
- Missing SEO opportunities in favor of brevity
|
|
- Prescriptive test scenarios that limit user flexibility
|