Drive the development process through API documentation
In recent communication with colleagues, I have also heard that adopting a “document-driven” collaboration mode can improve team collaboration efficiency and product quality compared to “develop documents first, maintain documents later” and “verbally communicate confirmation”.
Therefore, after understanding this, the project team recently found a tool to try to work based on documents, using a “document-driven” approach that can be followed to reduce a lot of meaningless communication costs.
Use Eolinker for development collaboration
At Eolinker, almost all of our collaborative work revolves around API interface documentation. Once the API documentation is created, anyone can view changes to the API at any time, initiate API tests from the API documentation, write API test cases, create Mock apis, automate API tests, and more.
Use address: www.eolinker.com=
Set the appropriate state for the API set the appropriate state for the API
Eolinker divides the state of the API into the following categories to help members understand the current state of the API when viewing the API documentation.
Published: The API is published and can be used normally
In design: Waiting or designing an API
To be determined: THE API has been designed and is waiting for relevant members to determine the content of the API
Development: API identified, waiting or under development
Docking: API developed, waiting or docking
Testing: API docking completed, waiting or testing
Finished: API has been tested and is awaiting release
Exception: The API is abnormal. Rectify the fault as soon as possible
Maintenance: THE API is being maintained or upgraded
Deprecated: The API is deprecated and cannot be used
Set change notification for the API set change notification for the API
You can set up the change notification function to automatically notify the relevant members of the API when the status or content changes by internal mail or email.
Comment on API Comment on API
You can use the API comment feature to post comments directly to the API documentation, and all communication remains with the API documentation and is sorted by version, rather than scattered across various chat tools.
Understand and compare API change histories
If you want to know what has been updated in the current version of an API, you can directly view the editing history of the API and compare the current version with a previous version. Or you can scroll back to any edit in history to see the details of the historical version.
