tzachbon/smart-ralph / plugins/ralph-specum/skills/communication-style
communication-style
VerifiedThis skill should be used when generating spec artifacts (research.md, requirements.md, design.md, tasks.md), formatting agent output, structuring phase results, or when any Ralph agent needs guidance on concise, scannable output formatting. Applies to all Ralph spec phase agents.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 2.2 KB |
| references/examples.md | markdown | 1.9 KB |
references/examples.md
View on GitHub# Output Examples by Phase
## Research Phase
### Bad (verbose)
```
The authentication system will need to handle user login functionality.
In order to accomplish this, we will need to implement a JWT-based
authentication mechanism that allows users to securely log in.
```
### Good (concise)
```
Auth system: JWT-based login
Components:
- Login endpoint: POST /auth/login
- Token generation: JWT with 24h expiry
- Middleware: verify token on protected routes
```
## Requirements Phase
### Bad (verbose)
```
As a user, I would like to be able to log into the system so that I
can access my personal dashboard and view my data in a secure manner.
The system should validate my credentials against the database.
```
### Good (concise)
```
**US-1: User Login**
- Actor: Registered user
- Action: Authenticate via email/password
- Outcome: Access personal dashboard
- AC: Valid creds -> JWT token + redirect to /dashboard
- AC: Invalid creds -> 401 + error message
```
## Design Phase
### Bad (verbose)
```
The authentication module will be responsible for handling all aspects
of user authentication including login, logout, token refresh, and
session management. It will communicate with the database layer.
```
### Good (concise)
```
## Auth Module
| Component | Responsibility | Interface |
|-----------|---------------|-----------|
| LoginHandler | Validate credentials | POST /auth/login |
| TokenService | Issue/refresh JWT | generateToken(), refreshToken() |
| AuthMiddleware | Guard protected routes | verifyToken() |
```
## Tasks Phase
### Bad (verbose)
```
The first task will be to create the authentication module directory
structure and set up the necessary files. After that, we will need
to implement the login endpoint and write tests for it.
```
### Good (concise)
```
- [ ] 1.1 Create auth module at src/auth/
- **Do**: mkdir src/auth, create index.ts, types.ts
- **Verify**: `ls src/auth/`
- **Commit**: `feat(auth): scaffold auth module`
```
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation). | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK). | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |