处理Azure文档的最佳实践

发布于 2025-01-30 10:46:15 字数 315 浏览 3 评论 0原文

云平台:Azure 资源:逻辑应用程序和功能

大家好,

kontext: 到目前为止,我们已经在公司中开发了许多逻辑应用程序和功能。我们不使用适当或标准的方法来处理用户需求的文档以及这些逻辑应用程序和功能所需的技术文档。对于技术文档,我的意思是在开发生命周期期间生成的所有文档。

我们还使用JIRA来分配公司内部的逻辑应用程序,并且我们正在使用X射线进行测试。我们还有汇合处记录我们的开发准则。

问题: 我想知道什么是处理文档的最佳实践,以及如何保持其最新状态非常重要? Azure,Jira或Confluence中是否可以轻松控制逻辑应用程序和功能的文档?

Cloud-Platform: Azure
Resource: Logic Apps and Functions

Hi everyone,

Kontext:
We have developed many Logic Apps and Functions in our company so far. We do not use a proper or standard methodology to handle the documentation of the user requirements and also the required technical documentation of these logic apps and functions. For technical documentation I mean all the documentation generated during the development life-cycle.

We use also Jira to assign the logic apps inside the company and also we are using X-RAY for testing. We have also Confluence for documenting our guidelines to development.

Question:
I would like to know what are the best practices to handle the documentation and very important how to keep it up-to-date?.
Is there an functionality in Azure, Jira or Confluence that we can control easily the documentation of our logic Apps and functions?

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(1

耀眼的星火 2025-02-06 10:46:15

它取决于您用来部署Azure函数和逻辑应用程序的源代码存储库和部署管道。如果您使用的是GitHub或Azure DevOps,则可以使用Github/DevOps Wiki来创建有关逻辑应用程序或功能项目的文档,仅通过创建readMe文件。请查看以下文章,这些文章将为您提供文档

https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis

https://learn.microsoft.com/en-icrosoft.com/en-us/azure/devops /project/wiki/wiki create-repo?view = azure-devops& tabs =浏览器

It depends on the source code repository and the deployment pipeline that you are using to deploy the Azure functions and logic apps. If you are using GitHub or Azure DevOps, then you can make use of the GitHub/DevOps wiki to create documentation about logic apps or function projects just by creating readme files. Please review the following articles which will help you with the documentation

https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis

https://learn.microsoft.com/en-us/azure/devops/project/wiki/wiki-create-repo?view=azure-devops&tabs=browser

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文