本文档为开发人员路线图平台创建高质量内容提供了全面的指南。它定义了编写指南、常见问题解答、问题以及roadmap.sh上出现其他类型内容的标准、格式和最佳实践。有关向系统添加新路线图的信息，请参阅添加新路线图。
roadmap.sh平台包含几种不同类型的内容，每种内容都有其特定的格式要求，同时共享通用的质量标准。
来源
所有内容文件必须在文件顶部包含 frontmatter（由三条破折号包围的元数据）。此元数据提供有关内容的基本信息，并控制其在网站上的显示方式。
对于指南，需要以下 frontmatter 字段
---
title: 'Guide Title'
description: 'A concise description of the guide content'
authorId: authorIdentifier
excludedBySlug: '/path/to/guide'
seo:
title: 'SEO-optimized title'
description: 'SEO-optimized description'
ogImageUrl: 'URL to open graph image'
relatedTitle: "Other Guides"
relatedGuidesId: relatedCategory
isNew: false
type: 'textual'
date: YYYY-MM-DD
sitemap:
priority: 0.7
changefreq: 'weekly'
tags:
- 'guide'
- 'textual-guide'
- 'guide-sitemap'
---
对于问题组，需要以下 frontmatter
---
order: number
briefTitle: 'Brief Title'
briefDescription: 'Brief description for the card view'
title: 'Full Title for the Page'
description: 'Full description for the page'
authorId: 'authorIdentifier'
isNew: boolean
date: YYYY-MM-DD
relatedTitle: "Other Guides"
relatedGuidesId: relatedCategory
seo:
title: 'SEO title'
description: 'SEO description'
keywords:
- 'keyword1'
- 'keyword2'
sitemap:
priority: number
changefreq: 'frequency'
questions:
- question: "Question text"
answer: filename.md
topics:
- 'Topic category'
---
对于常见问题文件，请使用此结构
---
import type { FAQType } from '../../../components/FAQs/FAQs.astro';
export const faqs: FAQType[] = [
{
question: 'Question text?',
answer: [
'First paragraph of answer.',
'Second paragraph of answer with optional [link text](https://roadmap.sh/path).',
],
},
// Additional FAQ items
];
---
来源
来源
问题以组的形式组织，每个问题都有一个单独的 markdown 文件作为答案。结构如下：
每个答案应遵循以下结构：
来源
内容应遵循以下风格指南：
专业而亲切：以清晰、指导性的语气写作，既权威又不居高临下。
直接简洁：使用主动语态、短句，避免不必要的行话或冗余词语。
教育重点：彻底而高效地解释概念，并提供实际示例。
全球受众：为国际受众写作，避免俚语、口语或特定文化参考。
第二人称视角：直接使用“你”而不是“我们”或“某人”来称呼读者。
示例
✅ “您可以使用 React hooks 实现此功能。”
❌ “我们可以使用 React hooks 实现此功能。”
✅ “开发 API 时，请遵循以下安全实践……”
❌ “当我们开发 API 时，您会想遵循这些安全实践……”
来源
来源
所有内容必须：
内容应全面但重点突出：
包含代码示例时：
来源
所有视觉内容应：
图片格式示例
表格应：
表格格式示例
| Header 1 | Header 2 | Header 3 |
|----------|----------|----------|
| Data 1 | Data 2 | Data 3 |
| Data 4 | Data 5 | Data 6 |
来源
下图展示了为开发人员路线图平台创建和提交内容的推荐流程：
来源
下图说明了内容如何与roadmap.sh代码库中的实际代码组件相关联：
来源
为最大限度地提高内容的发现性和影响力，请遵循以下 SEO 最佳实践：
关键词研究：识别并使用潜在读者可能搜索的相关关键词。
标题优化:
元描述:
内容结构:
内部链接:
图像优化:
SEO frontmatter 示例
来源
使用以下格式链接到平台内的其他路线图、指南或资源：
链接到路线图：[roadmap name](https://roadmap.sh/roadmap-slug)
示例：[前端路线图](https://roadmap.sh/frontend)
链接到指南：[guide title](https://roadmap.sh/guides/guide-slug)
示例：[如何成为前端开发人员](https://roadmap.sh/guides/how-to-become-frontend-developer)
链接到问题：[question category](https://roadmap.sh/questions/category)
示例：[前端问题](https://roadmap.sh/questions/frontend)
链接到其他 Wiki 页面：<FileRef file-url="https://github.com/kamranahmedse/developer-roadmap/blob/5ec61cc3/Page Title" undefined file-path="Page Title">你好</FileRef>
示例：[添加新路线图](#11.1)
链接到外部资源时：
示例：[Mozilla Developer Network](https://mdn.org.cn/)
引用代码库中的代码时，请使用此格式：
<FileRef file-url="https://github.com/kamranahmedse/developer-roadmap/blob/5ec61cc3/path/to/file#LNaN-LNaN" NaN file-path="path/to/file">Hii</FileRef>
示例：<FileRef file-url="https://github.com/kamranahmedse/developer-roadmap/blob/5ec61cc3/src/data/guides/frontend-languages.md#L1-L22" min=1 max=22 file-path="src/data/guides/frontend-languages.md">你好</FileRef>
来源
更新现有内容时，请遵循以下指南：
date 字段以反映更新。来源
相关主题的简要说明，附有进一步阅读的链接。
Sources:
- <FileRef file-url="https://github.com/kamranahmedse/developer-roadmap/blob/5ec61cc3/src/data/guides/frontend-languages.md#L1-L366" min=1 max=366 file-path="src/data/guides/frontend-languages.md">Hii</FileRef>
- <FileRef file-url="https://github.com/kamranahmedse/developer-roadmap/blob/5ec61cc3/src/data/guides/devops-principles.md#L1-L189" min=1 max=189 file-path="src/data/guides/devops-principles.md">Hii</FileRef>
- <FileRef file-url="https://github.com/kamranahmedse/developer-roadmap/blob/5ec61cc3/src/data/question-groups/frontend/content/css-variables.md#L1-L3" min=1 max=3 file-path="src/data/question-groups/frontend/content/css-variables.md">Hii</FileRef>
## Content Review Checklist
Before submitting content, use this checklist to ensure quality:
- [ ] **Accuracy**: Is all technical information correct and current?
- [ ] **Completeness**: Does the content cover the topic comprehensively?
- [ ] **Structure**: Is the content logically organized with appropriate headings?
- [ ] **Formatting**: Does the content follow the formatting guidelines?
- [ ] **Language**: Is the writing clear, concise, and free of errors?
- [ ] **Code Quality**: Are code examples correct, optimized, and secure?
- [ ] **Visual Elements**: Are images and diagrams clear, relevant, and accessible?
- [ ] **Links**: Are all links functional and appropriately descriptive?
- [ ] **SEO**: Does the content include appropriate keywords and metadata?
- [ ] **Accessibility**: Is the content accessible to all users?
Sources:
- <FileRef file-url="https://github.com/kamranahmedse/developer-roadmap/blob/5ec61cc3/src/data/guides/frontend-languages.md#L1-L366" min=1 max=366 file-path="src/data/guides/frontend-languages.md">Hii</FileRef>
- <FileRef file-url="https://github.com/kamranahmedse/developer-roadmap/blob/5ec61cc3/src/data/guides/devops-principles.md#L1-L189" min=1 max=189 file-path="src/data/guides/devops-principles.md">Hii</FileRef>
- <FileRef file-url="https://github.com/kamranahmedse/developer-roadmap/blob/5ec61cc3/src/data/guides/frontend-job-description.md#L1-L315" min=1 max=315 file-path="src/data/guides/frontend-job-description.md">Hii</FileRef>