Guidelines for updating feature documents

这是我给组里新入职writer写的一份如何为新feature更新文档的指南。共享出来,以供借鉴。

注:链接为内部链接,外部人员无法访问。

1. Understand the feature thoroughly

Begin by reviewing all available resources to fully understand the feature you're documenting. This includes:

Watch demos.

Review the feature description and test cases attached in the feature epic.

Read through existing documentation on similar features.

2. Gain practical experience

Try to use the feature directly in a test environment. It will help you understand how the feature behaves and further dig out useful information for readers. If you encounter any questions or have concerns about the feature, reach out to engineers or other writers familiar with it.

3. Analyze related documentation

Take time to study existing documents that relate to the new feature. This helps maintain consistency and ensures you’re not duplicating information unnecessarily. It can also provide context that’s valuable for structuring your own document.

4. Follow our writing style guide

Please ensure you’re adhering to the style guide, as this maintains consistency across all our documents:

Read and get familiar with Citrix Style Guide

Run Acrolinx before you send out a document for review.

Plus: For a broader understanding of the system and to build domain knowledge, explore DaaS-related Tech Zone articles.

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容