MCP HubMCP Hub
Вернуться к навыкам

write-validation-documentation

pjt222
Обновлено 2 days ago
1 просмотров
17
2
17
Посмотреть на GitHub
Метаwordtestingautomation

О программе

Этот навык создает комплексную документацию для валидации IQ/OQ/PQ компьютерных систем в регулируемых средах, таких как фармацевтика. Он формирует протоколы, отчеты, тестовые сценарии и обрабатывает отклонения для валидации программного обеспечения или подготовки к аудитам. Используйте его для квалификации программного обеспечения R или другого ПО на соответствие требованиям GxP, документирования вычислительных сред или создания пакетов валидации для регуляторных подач.

Быстрая установка

Claude Code

Рекомендуется
Основной
npx skills add pjt222/agent-almanac -a claude-code
Команда плагинаАльтернативный
/plugin add https://github.com/pjt222/agent-almanac
Git клонированиеАльтернативный
git clone https://github.com/pjt222/agent-almanac.git ~/.claude/skills/write-validation-documentation

Скопируйте и вставьте эту команду в Claude Code для установки этого навыка

Документация

書驗文

立全 IQ/OQ/PQ 驗文於計系。

用時

  • 驗 R 或他軟為監管用
  • 為監管審備
  • 錄計境之驗
  • 立或更驗程與報

  • 必要:欲驗之系/軟(名、版、用)
  • 必要:定範與策之驗計
  • 必要:用戶要規
  • 可選:現 SOP 模
  • 可選:前驗文(為再驗)

第一步:書安裝驗(IQ)程

# Installation Qualification Protocol
**System**: R Statistical Computing Environment
**Version**: 4.5.0
**Document ID**: IQ-PROJ-001
**Prepared by**: [Name] | **Date**: [Date]
**Reviewed by**: [Name] | **Date**: [Date]
**Approved by**: [Name] | **Date**: [Date]

## 1. Objective
Verify that R and required packages are correctly installed per specifications.

## 2. Prerequisites
- [ ] Server/workstation meets hardware requirements
- [ ] Operating system qualified
- [ ] Network access available (for package downloads)

## 3. Test Cases

### IQ-001: R Installation
| Field | Value |
|-------|-------|
| Requirement | R version 4.5.0 correctly installed |
| Procedure | Open R console, execute `R.version.string` |
| Expected Result | "R version 4.5.0 (2025-04-11)" |
| Actual Result | ______________________ |
| Pass/Fail | [ ] |
| Executed by | ____________ Date: ________ |

### IQ-002: Package Inventory
| Package | Required Version | Installed Version | Pass/Fail |
|---------|-----------------|-------------------|-----------|
| dplyr | 1.1.4 | | [ ] |
| ggplot2 | 3.5.0 | | [ ] |
| survival | 3.7-0 | | [ ] |

## 4. Deviations
[Document any deviations from expected results and their resolution]

## 5. Conclusion
[ ] All IQ tests PASSED - system installation verified
[ ] IQ tests FAILED - see deviation section

得:validation/iq/iq_protocol.md 完,附唯文 ID、目、先決清、為 R 裝與每需包之試例、偏差段、與批域。

敗則:組需異文式者,調模配現 SOP。要域(要、程、期果、實果、過敗)無論何式皆須存。

第二步:書運作驗(OQ)程

# Operational Qualification Protocol
**Document ID**: OQ-PROJ-001

## 1. Objective
Verify that the system operates correctly under normal conditions.

## 2. Test Cases

### OQ-001: Data Import Functionality
| Field | Value |
|-------|-------|
| Requirement | System correctly imports CSV files |
| Test Data | validation/test_data/import_test.csv (MD5: abc123) |
| Procedure | Execute `read.csv("import_test.csv")` |
| Expected | Data frame with 100 rows, 5 columns |
| Actual Result | ______________________ |
| Evidence | Screenshot/log file reference |

### OQ-002: Statistical Calculations
| Field | Value |
|-------|-------|
| Requirement | t-test produces correct results |
| Test Data | Known dataset: x = c(2.1, 2.5, 2.3), y = c(3.1, 3.5, 3.3) |
| Procedure | Execute `t.test(x, y)` |
| Expected | t = -5.000, df = 4, p = 0.00753 |
| Actual Result | ______________________ |
| Tolerance | ±0.001 |

### OQ-003: Error Handling
| Field | Value |
|-------|-------|
| Requirement | System handles invalid input gracefully |
| Procedure | Execute `analysis_function(invalid_input)` |
| Expected | Informative error message, no crash |
| Actual Result | ______________________ |

得:validation/oq/oq_protocol.md 含為數入、統計算、訛處之試例,各有特試數、期果(適時附容)、與證要。

敗則:試數未得者,立合成試數附已知性。錄數生法以使果可獨驗。

第三步:書效驗(PQ)程

# Performance Qualification Protocol
**Document ID**: PQ-PROJ-001

## 1. Objective
Verify the system performs as intended with real-world data and workflows.

## 2. Test Cases

### PQ-001: End-to-End Primary Analysis
| Field | Value |
|-------|-------|
| Requirement | Primary endpoint analysis matches reference |
| Test Data | Blinded test dataset (hash: sha256:abc...) |
| Reference | Independent SAS calculation (report ref: SAS-001) |
| Procedure | Execute full analysis pipeline |
| Expected | Estimate within ±0.001 of reference |
| Actual Result | ______________________ |

### PQ-002: Report Generation
| Field | Value |
|-------|-------|
| Requirement | Generated report contains all required sections |
| Procedure | Execute report generation script |
| Checklist | |
| | [ ] Title page with study information |
| | [ ] Table of contents |
| | [ ] Demographic summary table |
| | [ ] Primary analysis results |
| | [ ] Appendix with session info |

得:validation/pq/pq_protocol.md 含端到端試例,用實世(或代)數,果對獨參計(如 SAS 出)較。容明定。

敗則:獨參果未得者,記其缺並用雙編程(兩獨 R 之施)為別驗法。標 PQ 為暫直至獨驗畢。

第四步:書驗報

執程後,記果:

# Installation Qualification Report
**Document ID**: IQ-RPT-001
**Protocol Reference**: IQ-PROJ-001

## 1. Summary
All IQ test cases were executed on [date] by [name].

## 2. Results Summary
| Test ID | Description | Result |
|---------|-------------|--------|
| IQ-001 | R Installation | PASS |
| IQ-002 | Package Inventory | PASS |

## 3. Deviations
None observed.

## 4. Conclusion
The installation of R 4.5.0 and associated packages has been verified
and meets all specified requirements.

## 5. Approvals
| Role | Name | Signature | Date |
|------|------|-----------|------|
| Executor | | | |
| Reviewer | | | |
| Approver | | | |

得:驗報(IQ、OQ、PQ)完,諸試果已充、偏差已錄(或「None observed」)、結論已述、批簽域待簽。

敗則:執中試敗者,每敗錄為偏差附根因析與解。觀察敗時,勿留偏差段空。

第五步:可時自之

立自試本生證:

# validation/scripts/run_iq.R
sink("validation/iq/iq_evidence.txt")
cat("IQ Execution Date:", format(Sys.time()), "\n\n")

cat("IQ-001: R Version\n")
cat("Result:", R.version.string, "\n")
cat("Status:", ifelse(R.version$major == "4" && R.version$minor == "5.0",
                      "PASS", "FAIL"), "\n\n")

cat("IQ-002: Package Versions\n")
required <- renv::dependencies()
installed <- installed.packages()
# ... comparison logic
sink()

得:validation/scripts/ 中自本生證文(如 iq_evidence.txt),附每試例之時印果,減手入而保可重。

敗則:自本因境異而敗者,手行而以 sink() 捕出。錄自與手執之差於驗報。

  • 諸程有唯文 ID
  • 程引驗計
  • 試例有明過敗準
  • 報含諸執試果
  • 偏差已錄附解
  • 批簽已得
  • 文從組之 SOP 模

  • 泛接受準:「系正運」不可試。指精期值
  • 缺證:每試果需證(圖、記、出文)
  • 不全偏差處:諸敗皆須錄、究、解
  • 文無版控:驗文需變控如碼
  • 略再驗:系更(R 版、包更)需再驗評

  • setup-gxp-r-project - 為已驗境之項目結構
  • implement-audit-trail - 電錄追
  • validate-statistical-output - 出驗法

GitHub репозиторий

pjt222/agent-almanac
Путь: i18n/wenyan/skills/write-validation-documentation
0
agentsagentskillsai-assisted-developmentclaude-codeskillsteams

Похожие навыки

content-collections

Мета

Этот навык предоставляет проверенную в продакшене настройку для Content Collections — TypeScript-ориентированного инструмента, который преобразует файлы Markdown/MDX в типобезопасные коллекции данных с валидацией Zod. Используйте его при создании блогов, сайтов документации или контентных приложений на Vite + React для обеспечения типобезопасности и автоматической проверки содержимого. Он охватывает всё: от настройки плагина Vite и компиляции MDX до оптимизации развертывания и валидации схем.

Просмотреть навык

polymarket

Мета

Этот навык позволяет разработчикам создавать приложения на платформе прогнозных рынков Polymarket, включая интеграцию с API для торговли и получения рыночных данных. Он также обеспечивает потоковую передачу данных в реальном времени через WebSocket для отслеживания текущих сделок и рыночной активности. Используйте его для реализации торговых стратегий или создания инструментов, обрабатывающих обновления рынка в реальном времени.

Просмотреть навык

creating-opencode-plugins

Мета

Этот навык помогает разработчикам создавать плагины OpenCode, которые подключаются к более чем 25 типам событий, таким как команды, файлы и операции LSP. Он предоставляет структуру плагина, спецификации API событий и шаблоны реализации для модулей на JavaScript/TypeScript. Используйте его, когда вам нужно перехватывать, отслеживать или расширять жизненный цикл ассистента OpenCode AI с помощью пользовательской событийно-ориентированной логики.

Просмотреть навык

sglang

Мета

SGLang — это высокопроизводительный фреймворк для обслуживания больших языковых моделей (LLM), специализирующийся на быстрой структурированной генерации JSON, regex и рабочих процессов агентов с использованием кэширования префиксов RadixAttention. Он обеспечивает значительно более высокую скорость вывода, особенно для задач с повторяющимися префиксами, что делает его идеальным для сложных структурированных результатов и многократных диалогов. Выбирайте SGLang вместо альтернатив, таких как vLLM, когда вам требуется ограниченное декодирование или вы создаете приложения с интенсивным совместным использованием префиксов.

Просмотреть навык