Free developers from documentation

Free developers from documentation

I come from an SAP Background where it is a requirement to create much documentation is designed to make sure everything is in place. It is not working optimally.

There are two types of documentation

1) Flow description: This is about giving other developers and idea of what was created and how they can maintain it.

2) Change documentation: Give away to trace why some feature was changed and the reason why

Both are important and need to be created.

"Good" developers always talk about: "My code is self-documenting", "If you cannot understand it, you are not a developer" Or "There are comments in the code."

I have not seen a developer that enjoyed the writing documentation. You should value the developers you have on your project and ensuring they can focus on the work. Then your project cost will go down.

For SAP Integration (SAP PI/PO and CPI) there has not really been a good way to document what you had created. It was just given some overall idea and then copied past a lot. Since the copy-paste does not add a lot of value it may be time to improve it.

Automation of Integration documentation

In SAP Integration we have been working to create tools that allow users to create documentation automatically. This speed up the process so they can focus on solving business needs instead of writing documentation.

The Figaf tool will be creating both types of documentation that you need for your project. So you will get a scenario view and a change log information.

Developers will need to write some documentation that cannot be automated, like what the flow is doing some things and the functions they are creating. But the overall process and flow are created automatically so it will be consistent.

You can read more about the tool at https://figaf.com/IRT





Noor Mohammed

Sap Finance Control Consultant at Freelancer

5 年

Good Idea !!!!!!!!!!!!!

回复

要查看或添加评论,请登录

Daniel Graversen的更多文章

  • SAP Integration weekly: EOIO now in Integration Suite and SIT Madrid live

    SAP Integration weekly: EOIO now in Integration Suite and SIT Madrid live

    Spring is here in Denmark. I saw a hot air ballon on my road to the office today.

    2 条评论
  • SAP Integration weekly 11: Integration strategy

    SAP Integration weekly 11: Integration strategy

    There have been quite a bit of post his week around SAP integration. Groovy vs Function Libraries: Which one for your…

    4 条评论
  • SAP Integration week 10

    SAP Integration week 10

    I hope you had a great week. I was out most of the week with the Flu, which was worse than I remembered.

    1 条评论
  • SAP Integration Weekly 9: Migration playlist

    SAP Integration Weekly 9: Migration playlist

    I hope you had a great week. We are enjoying the last day of winter, now the spring starts.

    5 条评论
  • SAP Integration Weekly: Week 8

    SAP Integration Weekly: Week 8

    I have had some vacation with my family. We have been at an indoor water park and have spent much time in the water and…

    2 条评论
  • SAP Integration Week 7.

    SAP Integration Week 7.

    It is Friday, and time for the update of SAP Integration. There have been many people on winter vacation this week and…

    1 条评论
  • SAP Integration weekly

    SAP Integration weekly

    Friday Friendly Reminder: Next Figaf Webinar coming up this Tuesday Before I discuss the next webinar let me quickly…

    4 条评论
  • SAP Integration weekly

    SAP Integration weekly

    I hope you had a great week. I did have a lot of things to see.

    7 条评论
  • SAP Integration: Week 4. The importance of good architecture

    SAP Integration: Week 4. The importance of good architecture

    I hope you had a great week. The Importance of Good Architecture in Your SAP Integration A good architecture allows you…

    2 条评论
  • SAP Integration weekly Week 3

    SAP Integration weekly Week 3

    I hope you had a great week and a great start to 2025! 2025 seems to be an interesting year with a lot of new projects…

    7 条评论

社区洞察

其他会员也浏览了