Fine tune and enhance API Integration Project Specification Document for two platforms (80% work already completed)
$30-250 CAD
Closed
Posted over 1 year ago
$30-250 CAD
Paid on delivery
We are seeking an experienced Technical Writer to help create very detailed technical project specification documents for API integrations between two software applications.
In project, you will work closely with software developers, a project manager and other technical experts to gather information and create accurate, easy-to-understand documentation that clearly describes the functionality and requirements of the API integration. Your job is to explain the API integration structure of Showing Guide (our real estate property showing management software) with popular CRM applications such as HubSpot, FollowUpBoss, KV Core etc inbound and outbound.
Responsibilities:
Gather and analyze information from technical experts such as our software team and other stakeholders to understand the functionality and requirements of the API integration. (Third party CRM companies will give you necessary data and documentation).
Write clear, concise, and accurate technical project specification documents that describe the API integration in detail, including the purpose and scope of the integration, the functional and non-functional requirements, the high-level design, and the implementation plan
Collaborate with software developers, integration engineers, and other technical experts to ensure that the technical project specification document accurately reflects the capabilities and limitations of the API integration
Review and revise technical project specification documents as needed to ensure that they are up-to-date and accurate
Work with project managers and other stakeholders to ensure that the technical project specification document is delivered on time and meets all relevant quality standards
Knowledge In These Areas:
Experienced in the technical field, such as computer science, engineering, or a related discipline
3+ years of experience writing technical documentation, preferably for software applications or API integrations
Strong writing and communication skills, with the ability to translate complex technical concepts into clear, easy-to-understand language
Experience working with software developers and integration engineers to gather and analyze technical information
Proficiency with word processing and technical writing tools, such as LaTeX
Experience writing technical project specification documents for API integrations between two software applications
Familiarity with API development and integration technologies
Knowledge of software development lifecycle (SDLC) processes and best practices
Programming languages: API engineers often use programming languages such as Java, Python, Ruby, or C# to develop APIs and integrate them with other systems.
Web development frameworks: API engineers may use web development frameworks such as Django, Rails, or ASP.NET to build APIs that can be accessed over the internet.
API development platforms: There are many platforms available for developing APIs, such as Apigee, Azure API Management, and AWS API Gateway. These platforms provide tools and services for building, deploying, and managing APIs.
Integration technologies: API engineers may use technologies such as REST, SOAP, and JSON to enable communication and data exchange between different systems and applications.
Databases: API engineers may work with databases such as MySQL, Oracle, and MongoDB to store and retrieve data for use in APIs.
Cloud computing platforms: Many API engineers work with cloud computing platforms such as AWS, Azure, and Google Cloud to host and manage APIs.
If you are a highly skilled Technical Writer with a strong technical background and a passion for creating detailed, accurate documentation, we encourage you to apply for this exciting opportunity!
Hi Greetings!
With 8 years experience in Architecture of enterprise applications and practicing Togaf, i can provide the desired Architecture design document with interface specifications and if required other architecture views including detailed design , developer guide.
lets discuss to understand more about your expectations.
Thanks
Hi, thank you for this opportunity.
I am a talent software engineer with 7 years of experience.
I have experience in designing and implementing APIs, familiar with GraphQL and traditional RESTful ones.
I developed MES/ERP/CRM products for 4 years and skillful in R&D of backend APIs and integration with third party API.
I have gone through the requirements and propose to write the documentation but also participate in development.
Please discuss more with me.
Thank you.
?Hey Mate Jack H.?
I am senior software engineer with over 8 years of experience in Web/Software development.
I have reviewed the project description and willing to accomplish this task .
I have an rich experience in JSON, SOAP API, Ruby on Rails, REST API and Java.
I always adhere to a results-driven approach to working with meticulous attention to detail, periodic thorough code reviews, and critical thinking.
As an passionate and hard-working developer, I can complete your project within a given deadline.
Top quality, accurate schedule, free and courteous after-sales service are what I guarantee to my customers.
For more information about me, please refer to my portfolios.
I’m ready to discuss your project and start immediately.
Looking forward to hearing you back and discussing all details..
Looking forward to hearing from you soon
Hey!
I am really interested in this job. I’m data scientist working remotely with various analytical companies.
I’m offering best quality and highest performance at a price we are both comfortable with. I can complete your project on time and your will experience great satisfaction with me.
I’m well versed in R, python, SPSS, Stata, Excel etc
I have rich experienced in Java, REST API, SOAP API, Ruby on Rails and JSON.
For more information about me, please refer to my portfolios.
I’m ready to discuss your project and start immediately.
Looking forward to hearing you back and discussing all details..
Thank you!
Okay I understood your requirements but I have few doubts text me so I can clear my all doubts right away I can help you and I am ready for work.
Thank you.
Hi
Greetings!
I am available right now for the project discussion and can start the project
on an immediate basis. I have understood your project requirement
I have7++ experience in design and development. I can handle projects from small
styling to full development from scratch. I will provide a good result in a short time
and satisfy you fully.
We have experienced developers in
Java
Ruby on Rails
JSON
SOAP API
REST API
WHY-ME:
» Ready to Start as Immediate& Proper Testing.
» Keep your Data & Website Secure: Daily Progress Updates.
» You will get 30-days FREE BUG-SUPPORT even after Project-Completion
Please give me in touch and let's discuss more detail about your task via chat.
Project milestones will be decided during chat
Thanks and Regards
Deepika Jain
Black Grapes Softech
Hi Have 5+ years of experience in java application development throughout all phases of SDLC where I worked on REST and SOAP API Integration, as well development of SOAP and REST Web services, Parsing and processing of XML and JSON, worked with various banking & financial services client.
hoping to hear from you.
Thanks,