🚀 OSP营销工具开发人员指南
OSP Marketing提供了一系列基于大语言模型（LLM）的内容创作与优化工具，可用于生成、审查和优化技术内容，如产品文档、营销材料和博客文章等。
🚀 快速开始
OSP Marketing为技术内容创作提供了一套完整的解决方案，借助大语言模型，能有效提升内容创作的质量与效率。
✨ 主要特性
- OSP产品价值定位生成器：创建结构化价值主张地图，助力产品团队清晰传达产品独特卖点。
- OSP元数据生成器：为网页内容生成优化的标题、描述和关键词标签。
- OSP内容编辑器：利用专门编辑代码，提升技术写作的质量与一致性。
- OSP写作指南：提供结构化内容创作框架，帮助作者高效组织和撰写技术文档。
- OSP On - Page SEO优化指南：对网页内容进行全面的SEO优化。
📦 安装指南
安装要求
- Node.js（推荐使用版本14及以上）
- npm（Node包管理器）
安装步骤
- 克隆仓库：
git clone git@github.com:open-strategy-partners/osp-marketing-tools.git
cd osp-marketing-tools
- 安装依赖项：
npm install
- 启动开发环境（控制台模式）：
npm run dev
- 启动HTTP/SSE服务器模式：
npm run dev:sse
💻 使用示例
产品价值定位生成器
基础用法
npm run generate-value-map -- --product "CloudDeploy" --target-audience "DevOps工程师" --features "自动化部署流水线，Infrastructure as Code支持，实时监控，多云兼容性"
元数据生成器
基础用法
npm run generate-meta -- --title "如何有效使用Kubernetes" --description "全面指南帮助您最大化利用Kubernetes平台"
内容编辑器
基础用法
npm run edit-content -- --text "Kubernetes是一个容器编排平台。它处理应用程序的部署和按需扩展。有很多功能，效果很好。您应该在您的应用中使用它以提高弹性。"
写作指南
基础用法
npm run apply-writing-guide -- --topic "容器编排" --audience "开发者"
On - Page SEO优化指南
基础用法
npm run optimize-seo -- --url "https://example.com/kubernetes-tutorial" --content "Kubernetes教程：从入门到精通"
📚 详细文档
API接口
生成产品价值定位
创建一个新价值主张地图：
{
"product": "CloudDeploy",
"audience": "DevOps工程师",
"features": ["自动化部署流水线", "Infrastructure as Code支持", "实时监控", "多云兼容性"],
"benefits": {
"性能提升": "加快部署速度，提高系统稳定性",
"成本降低": "减少资源浪费和运营支出"
}
}
生成元数据
获取优化后的标题和描述：
{
"title": "如何有效使用Kubernetes",
"description": "全面指南帮助您最大化利用Kubernetes平台",
"keywords": ["Kubernetes", "容器编排", "云计算"]
}
内容编辑建议
获取内容改进建议：
{
"issues": [
{"type": "语法错误", "message": "在'Kubernetes是一个...'中，建议使用更专业的术语"},
{"type": "风格不一致", "message": "保持技术术语的一致性"}
],
"recommendations": [
{"type": "内容扩展", "message": "可以增加关于安全性的讨论"},
{"type": "结构优化", "message": "将长段落拆分为更易读的小节"}
]
}
🔧 技术细节
项目结构
osp-marketing-tools/
├── package.json # 项目依赖和脚本配置
├── src/ # 源代码文件夹
│ ├── generators/ # 各种内容生成器
│ │ └── ValueMapGenerator.js
│ ├── editors/ # 内容编辑工具
│ │ └── ContentEditor.js
│ └── optimizers/ # 优化模块
│ └── SEOOptimizer.js
├── scripts/ # 各种运行脚本
│ ├── generate-value-map.sh
│ ├── edit-content.sh
└── config/ # 配置文件夹
└── settings.json
📄 许可证
此项目遵循MIT许可证，具体内容如下：
版权所有 (c) 2023, Open Strategy Partners
许可证 MIT (MIT)
允许任何人免费使用、复制、修改、合并、发布和分发本软件及其衍生作品，只要保留版权声明和许可信息。
对于本软件可能引起的任何损害，无论是直接的还是间接的，作者或版权持有人概不负责。