Cline rules
.clinerules/docs-technical-style.mdCline rules
Quality
53/100
Scores the file, not the repository.Length
311 words
4 headings · 2 code blocksRepository
0
— · pushed 392 days agoLast changed
3 days ago
First indexed 3 days ago.1# Technical Documentation Style Guide23## General Principles45* **Clarity and Conciseness:** Write clearly and directly. Avoid jargon where simpler terms suffice. Get straight to the point, focusing on desired outcomes.6* **Accuracy:** Ensure all technical details, code examples, and instructions are correct and up-to-date. Regularly review and update documentation.7* **Consistency:** Maintain consistent terminology, formatting, and structure across all documentation. Use established naming conventions.8* **Audience:** Tailor the language and level of detail to the intended audience (e.g., developers, end-users, other AI agents).9* **Focus on Outcomes:** Describe the results you want, not just the specific steps.1011## Formatting1213* **Headings:** Use Markdown headings (`#`, `##`, `###`, etc.) logically to structure content. Follow a consistent hierarchy.14* **Code Blocks:** Use fenced code blocks (```) for all code examples, configuration files, and terminal commands. Always specify the language for syntax highlighting (e.g.,```typescript, ```json,```bash).15* **Inline Code:** Use backticks (`) for inline code, file names, directory names, and technical terms (e.g.,`npm install`,`package.json`,`AgentState`).16* **Lists:** Use bullet points (`*` or `-`) for unordered lists and numbers (`1.`, `2.`) for ordered lists.17* **Bold and Italic:** Use bold (`**text**`) for emphasis and italic (`*text*`) for terms being introduced or for titles of books/articles.1819## Content Guidelines2021* **Introduction:** Every document should start with a brief introduction outlining its purpose and what it covers.22* **Examples:** Provide practical code examples or usage scenarios where applicable. Ensure examples are runnable and demonstrate the concept clearly.23* **Diagrams:** Use diagrams (e.g., Mermaid diagrams) to illustrate complex flows, architectures, or relationships. This is crucial for visualizing LangGraph workflows.24* **Cross-referencing:** Link to related documentation within the project or to external resources (e.g., LangChain.js docs, LangGraph.js tutorials) where appropriate.25* **Version Control:** Document changes and updates, potentially via `CHANGELOG.md` or similar versioning mechanisms.26* **Prerequisites:** Clearly list any prerequisites or dependencies required for understanding or implementing the documented content.27
Also in ssdeanx/langgraph-dm
Diff this repo’s formatsOne repository carrying more than one format is the comparison this product exists for: does anyone actually write different content in each file, or is one a copy of the other?
| Repository | Format | Stack | Covers | Score | Changed |
|---|---|---|---|---|---|
| ssdeanx/langgraph-dm.clinerules/memory.md · 0 | Cline rules | styleperformance | 43/100 | 3 days ago | |
| ssdeanx/langgraph-dm.clinerules/agents.md · 0 | Cline rules | typesagent-behaviour | 44/100 | 3 days ago | |
| ssdeanx/langgraph-dm.clinerules/development_guidelines.md · 0 | Cline rules | setupbuildtestlint-format+3 | 83/100 | 3 days ago | |
| ssdeanx/langgraph-dm.clinerules/langgraphjs.md · 0 | Cline rules | arch | 52/100 | 3 days ago | |
| ssdeanx/langgraph-dm.clinerules/project_overview.md · 0 | Cline rules | testlint-formatstylearch | 75/100 | 3 days ago | |
| ssdeanx/langgraph-dm.clinerules/subgraphs.md · 0 | Cline rules | agent-behaviour | 48/100 | 3 days ago | |
| ssdeanx/langgraph-dm.github/copilot-instructions.md · 0 | Copilot instructions | setupsecuritydeploymentdo-not+2 | 57/100 | 3 days ago | |
| ssdeanx/langgraph-dm.windsurf/rules/graphs.md · 0 | Windsurf rules | do-not | 55/100 | 3 days ago | |
| ssdeanx/langgraph-dm.windsurf/rules/langsmith.md · 0 | Windsurf rules | do-notagent-behaviour | 55/100 | 3 days ago |
Diff against .clinerules/memory.md Diff against .clinerules/agents.md Diff against .clinerules/development_guidelines.md Diff against .clinerules/langgraphjs.md Diff against .clinerules/project_overview.md Diff against .clinerules/subgraphs.md Diff against .github/copilot-instructions.md Diff against .windsurf/rules/graphs.md Diff against .windsurf/rules/langsmith.md
Similar configs
Same format, overlapping stack, ranked by quality.
| Repository | Format | Stack | Covers | Score | Changed |
|---|---|---|---|---|---|
| bashdeban/fastmind.clinerules/.project-consistency-keeper2.md · 5 | Cline rules | setupbuildtestlint-format+11 | 100/100 | 3 days ago | |
| JCodesMore/ai-website-cloner-template.clinerules · 31k | Cline rules | buildlint-formatstylearch+3 | 97/100 | 2 days ago | |
| u9401066/zotero-keeper.clinerules/50-pubmed-project.md · 6 | Cline rules | testlint-formatstylearch+1 | 94/100 | 3 days ago | |
| u9401066/zotero-keepervscode-extension/resources/repo-assets/pubmed-search-mcp/.clinerules/50-pubmed-project.md · 6 | Cline rules | testlint-formatstylearch+1 | 94/100 | 3 days ago | |
| VaillerTeeter/HoshimiNest.clinerules/project-identity.md · 1 | Cline rules | setuparchtypesdo-not | 93/100 | yesterday | |
| blendsdk/codeops-mcp.clinerules/project.md · 0 | Cline rules | buildteststylearch+7 | 91/100 | 3 days ago | |
| cline/cline.clinerules/general.md · 66k | Cline rules | setupbuildstylearch+2 | 86/100 | 3 days ago | |
| u9401066/zotero-keeper.clinerules/60-pubmed-python.md · 6 | Cline rules | setuptestlint-formatstyle+2 | 86/100 | 3 days ago |
