¿Cómo se comparte la documentación del SDLC?

In my experience, having a transparent view to all stakeholders is key. In our organization we have been using Atlassian products very successfully. We use Confluence for writing our PRDs and design documentation. We use draw.io for doing our infrastructure design. We use Figma for user experience design. All these are finally linked in a JIRA user story and picked up by the development team.

Sharing SDLC documentation effectively is crucial for collaboration, understanding, and transparency among team members. Here are some common methods: - Document Repository or Version Control System: Tools like Git, GitHub, GitLab, Bitbucket, or others to host your documentation. - Project Management Tools: Platforms like Jira, Trello, Asana, or Azure DevOps. - Cloud Storage Platforms: Utilize solutions like Google Drive, Dropbox, OneDrive, or Box. - Collaboration Platforms: Platforms like Confluence, SharePoint, or Notion etc. - Wiki Pages: Tools like MediaWiki or DokuWiki, allows easy navigation and updates. - Documentation as Code: Tools like Sphinx or Jekyll can generate documentation from code comments. - Email Communication

I tend to favor open, durable, and reliable formats. This typically means markdown directly in the same repo with the code. This makes it easier to involve project staff who actually work on the project and maintain over time. It's simple enough that any human can learn in 15 minutes. And it requires no new infrastructure. In fact, I don't want anyone on my project who won't commit to learning markdown and git, as it's literally simple enough for anyone to learn and use. Markdown provides enough functionality and keeps it simple to capture basic architecture and use case info.

Match the format to the audience! Tech specs for devs, user stories for all, manuals made simple for clients. Dial down the jargon for newbies, crank it up for techies. Find the right voice, formal for stakeholders, friendly for colleagues. With the perfect format, your docs become everyone's guide to SDLC success!

In my experience with sharing SDLC documentation, I prioritize transparent communication and accessibility. For instance, utilizing collaborative platforms such as Confluence or SharePoint ensures team members have easy access to the latest documents. An example of this is our regular sync-ups and use of version control systems to maintain document accuracy. I agree that fostering open channels for feedback is crucial, as it promotes continuous improvement in our development processes.

The most effective documentation is that which is most accessible to the broadest audience. That means that you don’t assume deep knowledge from your readers, but take them from wherever they are and bring them to having deeper knowledge. Ideally surpassing you one day. As to formats and tools, use what is most accessible AND easiest for others to collaborate with. Learn as you teach. My current choice is GitHub and related tools. They are widely known by tinkerers and industry experts. Go where the audience is.

Creating and managing documentation for the SDLC requires a variety of tools, such as text editors and word processors for writing, markup languages for formatting, diagramming and modeling tools for visualizing, code editors and IDEs for generating, testing and debugging tools for verifying software quality. The following tools are available to help manage the SDLC process. Request for access can be made via the Technology Support Center Confluence: Online tool used for capturing and sharing. Jira: Online Bug/Issue/Task/Project trackinf system Bitbucket: Web UI/Online remote Git repository manager Source Tree: Stand-alone application, leveraging Git version control system. Bamboo: Continuous integration/release management

Version management and public distribution of Steady state documents are extremely important for SDLC. The Document Management tool plays a pivotal role in this field.

Confluence / Internal website: To document project workflow, requirements changes, business logic Jira board: Sprint planning, bugs/tasks tracking

Use a documentation tool, such as Confluence Cloud, to create a central repository for your SDLC documentation. This will make it easy to share documentation with your team and track changes. Leverage a documentation tool like Document360 or Snyk to securely share documents with specific team members or stakeholders. Employ a diagramming tool like Draw.io or Lucidchart to create visual representations of SDLC processes, making it more engaging and easier to understand. Utilize VCS like Git or Subversion to track changes to documents and revert to previous versions if necessary. Consider using a documentation management system like Atlassian Confluence or Snyk to organize, collaborate on, and manage SDLC documentation effectively.

For establishing documentation process the below tools which helps in creating proper flow diagram of the project. Such as Visio , Draw.io, miro , figma and lucid charts

Establish a clear documentation process in SDLC by defining goals, identifying documentation types, assigning roles, choosing tools, developing templates, establishing a review process, maintaining documentation, providing easy access, encouraging feedback, and integrating documentation into the SDLC.

Documentation varies per company or customer preferences. It is always helpful to put one time effort in generating standard templates or pointers for yourself or your team for each phase of the SDLC lifecycle. These templates could act as a base for quick-starting phase work. For instance, one can prepare the sample format that covers all points for a high level scope of a project and ensure that all mentioned parameters are covered from it. This will ensure that minimum scoping parameters are never missed and we can build data on top of it. Such templates can be easily merged in any format. Some helpful tools: Jira, Confluence, lucid charts, BMPN flow diagrams

Begin with: Define the Scope and Objectives Identify Documentation Owners Develop Documentation Templates Create Documentation Tools Establish a Review and Approval Process Promote Documentation Adoption Continuously Review and Update

A well-defined documentation process is the secret weapon of efficient SDLC teams. By outlining roles, establishing clear standards, and creating a workflow, you ensure everyone is on the same page. This clarity fosters alignment with project goals, sets expectations, and keeps tasks and deadlines on track. The process, formal or informal depending on project size, can also include review, approval, and distribution steps.

In my experience, we've used SharePoint to capture the Documentation, Meeting Minutes, Configurations, and test plans for each phase of the Cycle. This works well in Agile environments when you have the same repeating steps over and over for each release. Also, allows you to see what is repetitive and you can automate or script out those same steps and take that time off the release and those responsible for performing those tasks.

The document library works best if it has an easily configured security system. Access to the documentation needs to control who can Read, Write, Amend or Delete content of the library. Most collaboration and project management tools will provide these facilities but the responsibility of setting the access needs to be managed. If the subject matter is commercially sensitive it may be necessary to encrypt the data. Especially if you use a hosted service. However, if the data remains within the company firewalls encryption is not needed. External access should be provided through a secure gateway. No data should leave the organisation's servers. I've used Teams and SharePoint in conjunction with MS Project and Oracle Primavera.

This is a tough one with ever evolving requirements, and needs, I would say trust is the most important requirement in the team, otherwise security access controls become "friction" in the document creation and update process leaving it stale, outdated and not useful Security should be natural, and is not a replacement for team dysfunction

- Within team or firm, any tool can be accessible, no need to take special action for authentication - For authorization / limited access, we define role based on confidentiality - For external user (client, point of contact), we can create an Account / mailid and give them limited access

In our Visual Studio project is a Documents folder, and houses the design docs, setup doc, and user's guide, and possibly an occasion Tech Reference. That way everything gets into version control, yet developers can find the documents needed. It is important to update documents, as needed. Do the documentation as you go forward, make it part of your daily routine. After all you are a professional, not a slacker who waits to do at the end. Those who don't, usually intend to leave an organization in the near future.

- Improvement is organic - Gradually based on experiences, we can alter it - Open for changes and feedback - Not to loose documentation - During the time of escalation, crisis, if we are unable to find the correct information. Time to refine and change

In sharing SDLC documentation, actively seek and incorporate feedback from stakeholders, team members, and clients. This process identifies and rectifies errors and gaps, enhances clarity and usability, and integrates new features. Use surveys, comments, conversations, or reviews to gather feedback. Responsiveness to feedback is crucial—acknowledge and update documentation promptly and courteously. This approach increases satisfaction, trust, and ensures documentation remains relevant and effective.

Documentation should be easy to create, and update, be useful such that the end-users are happy to provide feedback The key is always to reduce "friction" leading to users to have to "think" about hurdles to getting the documentation done

Don't let your SDLC documents become stagnant! Actively solicit feedback from team members, stakeholders, and even clients. Their insights can expose errors, highlight areas for improvement, and suggest new functionalities. This feedback loop promotes clear, user-friendly documents that drive user satisfaction and build trust. Use surveys, comments sections, or dedicated reviews to gather this valuable input. Remember to respond promptly and professionally, incorporating suggestions to continuously refine your documentation.

When creating SDLC documentation, consider your audience. When documentibg for a business requirement, you need to provide a visualization tied to the business controls it supports. On the other hand, the best SDLC documentation for a developer is a working example.

SDLC documentation can be shared through various means, depending on the organization's preferences and the nature of the documentation. Common methods include sharing documents via email, uploading them to a shared drive or document management system, presenting them in meetings or workshops, or using collaboration tools like Google Docs or Microsoft SharePoint. Additionally, some organizations may choose to publish documentation on internal websites or intranets for easy access by team members.

SDLC (Software Development Life Cycle) documentation can be shared using various methods depending on the stage of the development process and the preference of the team or organization. Common methods include sharing files via email, cloud storage platforms, version control systems, or using collaborative tools such as Google Docs, MS Teams, or Confluence. It is important to ensure that any shared documentation is kept up-to-date and accessible to all relevant stakeholders.

1. Version control: Track changes, revert if needed, and maintain an audit trail using a version control system. 2. Security: For sensitive projects, restrict document access with clear permissions. 3. Localization: Consider translating documents for a global audience if needed.

It involves utilizing accessible platforms and maintaining clarity. Cloud-based collaboration tools, such as Google Drive or SharePoint, provide centralized storage and easy access for team members. Organize documentation logically, creating folders for different phases of the SDLC. Use version control to track changes and updates, ensuring everyone has access to the latest information. Consider supplementing written documentation with visual aids like flowcharts or diagrams to enhance understanding. Regularly communicate updates, changes to the team, fostering transparency and alignment. By employing user-friendly platforms, maintaining clear communication channels, sharing SDLC documentation becomes a streamlined, collaborative process.