The latest articles on DEV Community by KeyboardInterrupt (@keyboardinterrupt). https://dev.to/keyboardinterrupt https://media2.dev.to/dynamic/image/width=90,height=90,fit=cover,gravity=auto,format=auto/https:%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Fuser%2Fprofile_image%2F454948%2Fdad9e464-a307-4971-a36d-1821e4d5b38b.png https://dev.to/keyboardinterrupt en KeyboardInterrupt Tue, 11 Mar 2025 10:42:13 +0000 https://dev.to/keyboardinterrupt/serviceproject-evaluation-and-integration-checklist-1kmd https://dev.to/keyboardinterrupt/serviceproject-evaluation-and-integration-checklist-1kmd <p><a href="https://media2.dev.to/dynamic/image/width=800%2Cheight=%2Cfit=scale-down%2Cgravity=auto%2Cformat=auto/https%3A%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Farticles%2Fv4wzfw4yp8ki1h3k4xwr.jpg" class="article-body-image-wrapper"><img src="https://media2.dev.to/dynamic/image/width=800%2Cheight=%2Cfit=scale-down%2Cgravity=auto%2Cformat=auto/https%3A%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Farticles%2Fv4wzfw4yp8ki1h3k4xwr.jpg" alt="Service/Project Evaluation and Integration Checklist" width="800" height="450"></a></p> <p>Launching or integrating a new service or project can be challenging. I've been in situations where I overlooked something important halfway through. To avoid that, I created this checklist of questions to reference whenever needed.</p> <p>It covers essential areas like ownership, infrastructure, security, compliance, and scalability, helping to assess risks, operational impact, and costs. By answering these questions, you gain a clearer understanding of dependencies, performance, and long-term maintainability.</p> <h2> Contact Persons and Project Responsibility </h2> <ul> <li>Who are the primary internal contacts for the project within our company, clients, and partners/suppliers?</li> <li>How will communication be managed with these contacts (e.g., regular meetings, emails, project management tools)?</li> <li>What is the priority of this project compared to ongoing activities or other parallel projects?</li> <li>Who will be the point of contact for the project after implementation, and who will actively participate in the implementation phase?</li> </ul> <h2> Service Interface </h2> <ul> <li>Who is responsible for each component of the project/operation (e.g., development, deployment, support)?</li> <li>What communication channels will be used for service requests, change requests, and support (e.g., email, ticketing system)?</li> <li>How frequently are service requests or change requests expected?</li> <li>What are the agreed-upon SLAs for: <ul> <li>Response times to requests?</li> <li>Processing times for requests?</li> <li>Resolution times for requests?</li> </ul> </li> <li>Is there an on-call service agreement in place with our clients and partners? If yes, what are the terms?</li> <li>Do our clients and partners also provide on-call service, and if so, what are the terms?</li> </ul> <h2> Infrastructure </h2> <ul> <li>On which platforms will the service components operate (e.g., Cloud, VMware, OpenStack, Kubernetes, bare metal, on-premises)?</li> <li>Are there any external systems we depend on (e.g., VPN, third-party APIs, external databases)? If so, what are they?</li> <li>Do we need to distribute components across multiple availability zones to ensure availability through redundnacy?</li> <li>How will communication be handled between different platforms and systems in a mixed environment (e.g., cloud/on-premises, different cloud providers)?</li> <li>Are there any single points of failure (SPOFs) in the infrastructure that need to be addressed?</li> </ul> <h2> Installation, Commissioning, and Onboarding </h2> <ul> <li>What is the detailed commissioning process for the project or service?</li> <li>Who is responsible for carrying out the installation: a partner, the client, or our internal teams?</li> <li>Can the installation be automated, and thus, repeated easily across environments? Is this process documented?</li> <li>Does the installation depend on any external systems or tools (e.g., licensing servers, external configurations)?</li> <li>Are there licensing requirements (e.g., license keys, product activation)?</li> <li>What is the data migration process for transferring existing data to the new service, and how will this be managed during on-boarding?</li> </ul> <h2> Dependencies </h2> <ul> <li>What dependencies exist within internal teams (e.g., development, operations, security) and external partners/systems?</li> <li>What are the potential consequences if these dependencies are unavailable (e.g., service downtime, delayed timelines)?</li> <li>Are there clear processes for managing these dependencies and handling disruptions?</li> <li>Can the requirements in this document be answered for each identified dependency, including their availability and SLAs?</li> </ul> <h2> Data </h2> <ul> <li>How will data be accessed and interacted with in the new service (e.g., via API, direct database access)?</li> <li>Where will the data be stored (e.g., on-premises storage, cloud storage, hybrid storage)?</li> <li>What type of storage will be used (e.g., SSDs for speed, HDDs for cost, object storage for scalability)?</li> </ul> <h2> Data Protection </h2> <ul> <li>Does the service comply with data protection regulations such as GDPR or local laws? Are we adhering to all applicable privacy laws?</li> <li>Are any personal data or sensitive information being stored or processed (e.g., customer names, financial data)?</li> <li>Can the data collection be minimized by adjusting log levels or anonymizing data?</li> <li>Is encryption implemented for data in transit (e.g., TLS/SSL) and data at rest (e.g., encrypted databases)?</li> <li>How is sensitive data stored securely, and is it encrypted as required by legal and regulatory standards?</li> </ul> <h2> Backup &amp; Restore </h2> <ul> <li>What specific data needs to be backed up (e.g., user data, system configurations, databases)?</li> <li>How often should backups occur (e.g., daily, weekly, monthly), and what is the retention policy for backups?</li> <li>Who will be responsible for managing and executing the backups?</li> <li>How will backup integrity be verified (e.g., checksum validation, periodic testing)?</li> <li>What happens if a backup is lost or corrupted, and how will this be mitigated?</li> <li>Who will have access to backups, and are there privacy and compliance concerns regarding backup access?</li> <li>What is the procedure for restoring backups in case of data loss or system failure?</li> </ul> <h2> Disaster Recovery </h2> <ul> <li>In the event of a disaster, which components must be restored first (e.g., production systems before development)?</li> <li>Who needs to be informed during a disaster recovery event, and how will they be notified?</li> <li>What immediate actions must be taken following a failure (e.g., failover, rollback, emergency meetings)?</li> <li>What is the Recovery Time Objective (RTO) for the critical systems and services, i.e., how long can they be down before business operations are impacted?</li> <li>What is the Recovery Point Objective (RPO), i.e., how much data loss is acceptable during a failure?</li> <li>How often will we test disaster recovery procedures to ensure they work as expected?</li> </ul> <h2> Monitoring </h2> <ul> <li>What monitoring endpoints are available for the service (e.g., health checks, performance metrics)?</li> <li>Who is responsible for monitoring the service components, and how will monitoring responsibilities be distributed?</li> <li>How will incidents be triggered and who will be notified (e.g., on-call staff, support teams)?</li> <li>Will the monitoring notifications depend on business hours, or will they be continuous (e.g., 24/7)?</li> <li>What are the most important business processes or KPIs that need to be monitored to ensure service performance?</li> <li>Are there any critical components (e.g., custom services) that require special monitoring beyond standard health checks?</li> </ul> <h2> Updates, Maintainability, and Maintenance Agreement </h2> <ul> <li>How often will the software and services receive updates (e.g., weekly, monthly, as needed)?</li> <li>What is the expected timeline for installing updates, and who will manage them?</li> <li>What maintenance windows need to be agreed upon with clients, partners, and internal teams?</li> <li>Are there specific internal or partner teams required to support regular maintenance?</li> <li>What recurring maintenance tasks need to be automated (e.g., certificate renewals, scaling)?</li> <li>Can updates or upgrades be performed automatically ("unattended") without manual intervention?</li> </ul> <h2> Availability </h2> <ul> <li>What are the service availability requirements (How many nines, 99.9%, 99.99%, 99,999%)?</li> <li>Is availability required at all times, or only during specific periods (e.g., business hours)?</li> <li>Can the service be deployed in a cluster for high availability or load balancing?</li> <li>What failover mechanisms are in place, and how are they tested (e.g., active/passive, automatic failover)?</li> </ul> <h2> Non-Standard Software and Software Support </h2> <ul> <li>What are the core technologies or software components that the service depends on (e.g., operating systems, databases, libraries)?</li> <li>Are these technologies standard or proprietary, and are there known risks (e.g., limited support, outdated)?</li> <li>Is there available support for these software components, and if not, what expertise is required to maintain them internally?</li> </ul> <h2> Personnel &amp; Training </h2> <ul> <li>Is training required for employees involved in operation, installation, or administration of the service?</li> <li>Which specific employees or teams will need to receive training?</li> <li>Does the project require additional personnel or outsourcing to meet staffing requirements?</li> </ul> <h2> Licensing </h2> <ul> <li>What type of licensing model is used for the service (e.g., subscription, perpetual, per-user)?</li> <li>Are there any obligations arising from the licensing model (e.g., open-source licensing, commercial licensing)?</li> <li>Are any licenses required for components, and what are the associated recurring or one-time costs?</li> <li>Are license upgrades or feature expansions expected, and could they impact costs or operations?</li> </ul> <h2> Scaling </h2> <ul> <li>What growth is expected for the service in terms of user base, data, or traffic?</li> <li>How will scaling be achieved (e.g., horizontally, vertically)?</li> <li>What are the strategies for scaling down or releasing resources during off-peak times?</li> <li>Are there any known bottlenecks (e.g., database, network, compute) that might limit scalability?</li> <li>What are the cost implications of scaling (e.g., per-user, per-transaction, per-GB)?</li> <li>How will performance be monitored to detect scaling issues?</li> <li>What are the key performance indicators (KPIs) to track scalability (e.g., response time, throughput, latency)?</li> <li>How will load balancing be managed as the service scales?</li> <li>Will the scaling process be automated, and if so, how?</li> <li>What is the strategy for database scaling (e.g., sharding, replication)?</li> <li>How will data consistency be maintained during scaling (e.g., eventual consistency vs. strong consistency)?</li> <li>What is the approach for handling sudden traffic spikes (e.g., auto-scaling, traffic prioritization)?</li> <li>Are there regional considerations for scaling, such as data residency or latency concerns?</li> <li>What are the failover strategies in case of scaling issues or system failures?</li> </ul> <h2> Compliance </h2> <ul> <li>What legal, regulatory, or industry standards must the service comply with (e.g., HIPAA, PCI-DSS, SOC 2)?</li> <li>Will the service be subject to audits? If so, what is the expected frequency and scope of these audits?</li> <li>What level of effort is required from the internal team to prepare for these audits?</li> <li>Does the service meet internal security standards (e.g., vulnerability management, patching)?</li> </ul> <h2> Documentation </h2> <ul> <li>Is there existing project or product documentation (e.g., requirements, design)?</li> <li>Who is responsible for creating or maintaining the operational manual?</li> <li>Is there a known issues log or troubleshooting guide available for the service?</li> <li>Is there an architecture diagram or documentation to clarify the service’s infrastructure and components?</li> <li>What additional documentation is available (e.g., user guides, tutorials, FAQs)?</li> </ul> <h2> Additional Considerations </h2> <ul> <li>Are performance benchmarks (e.g., latency, throughput, uptime) defined, and are they being met?</li> <li>What is the process for managing changes to the service, including versioning, upgrades, and impact analysis?</li> <li>How will changes to the service affect users or clients, and how will these changes be communicated?</li> <li>Does the service/project have an <strong>exit strategy</strong> , including data portability and service decommissioning?</li> </ul> <p>🖼 Foto von <a href="https://unsplash.com/de/@hadijasaidi?utm_content=creditCopyText&amp;utm_medium=referral&amp;utm_source=unsplash" rel="noopener noreferrer">Hadija</a> auf <a href="https://unsplash.com/de/fotos/ein-schild-das-sich-an-der-seite-eines-hugels-befindet-jCfDzOQ2-C8?utm_content=creditCopyText&amp;utm_medium=referral&amp;utm_source=unsplash" rel="noopener noreferrer">Unsplash</a></p> checklist KeyboardInterrupt Fri, 21 Feb 2025 12:37:12 +0000 https://dev.to/keyboardinterrupt/how-to-amplify-team-productivity-and-become-a-true-10x-developer-2d3k https://dev.to/keyboardinterrupt/how-to-amplify-team-productivity-and-become-a-true-10x-developer-2d3k <p><a href="https://media2.dev.to/dynamic/image/width=800%2Cheight=%2Cfit=scale-down%2Cgravity=auto%2Cformat=auto/https%3A%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Farticles%2Fvlk99jezb84prilita6z.jpeg" class="article-body-image-wrapper"><img src="https://media2.dev.to/dynamic/image/width=800%2Cheight=%2Cfit=scale-down%2Cgravity=auto%2Cformat=auto/https%3A%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Farticles%2Fvlk99jezb84prilita6z.jpeg" alt="How to Amplify Team Productivity and Become a True 10x Developer" width="800" height="533"></a></p> <p>In the world of software development, the term “ <strong>10x developer</strong> ” is often thrown around to describe someone who can produce results far beyond the typical output. However, the true 10x developer isn’t focused on personal performance; they’re someone who drives the entire team to perform at its best.</p> <p>Here’s how you can become that developer—one who helps the whole team achieve greater success:</p> <ul> <li> <strong>Build for the Team, Not Just Yourself</strong> A great developer doesn’t make tech decisions based solely on personal preferences. By considering your team’s skill set, you ensure smoother collaboration and more predictable results. This approach makes everyone feel capable, boosting the team’s overall productivity.</li> <li> <strong>Negotiating Simpler Features for Less Complexity</strong> Simplicity is key. Instead of pushing for overly complex features, propose effective, simpler solutions that everyone can implement easily. This approach reduces mental load, helps everyone move faster, and ensures the team stays focused on what truly matters.</li> <li> <strong>Share Knowledge, Boost Efficiency</strong> A true 10x developer shares insights across different technical areas. By spotting patterns and connecting the dots, you help your colleagues avoid common pitfalls and tackle challenges more effectively. This creates a culture of learning that improves everyone’s output.</li> <li> <strong>Rejecting Ambiguity – Clarity Equals Speed</strong> Ambiguity slows everything down. By ensuring everyone is on the same page from the start, you eliminate confusion and rework. Clear expectations keep the team moving forward, which means faster, more efficient progress.</li> <li> <strong>Documenting everything – Share What You’ve Learned</strong> Good documentation helps everyone understand and apply the patterns you’ve created. Instead of starting from scratch, your team can build on your work, saving time and reducing errors. Knowledge-sharing improves long-term team efficiency.</li> </ul> <p><strong>Becoming a 10x developer is about amplifying your team’s success</strong> , not just your own. By simplifying, sharing, and ensuring clarity, you help everyone perform at their best. The result? Faster deliveries, fewer bottlenecks, and a team that works seamlessly together.</p> <p>Ultimately, a true 10x developer doesn’t focus on personal productivity—they focus on creating an environment where the entire team can excel. And that’s where the real magic happens.</p> 10xdeveloper careergrowth KeyboardInterrupt Sat, 15 Feb 2025 11:27:47 +0000 https://dev.to/keyboardinterrupt/navigating-the-ai-hype-stay-smart-stay-calm-and-stay-ahead-26ke https://dev.to/keyboardinterrupt/navigating-the-ai-hype-stay-smart-stay-calm-and-stay-ahead-26ke <p><a href="https://media2.dev.to/dynamic/image/width=800%2Cheight=%2Cfit=scale-down%2Cgravity=auto%2Cformat=auto/https%3A%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Farticles%2F6crxfldh3dzw86csvk00.jpg" class="article-body-image-wrapper"><img src="https://media2.dev.to/dynamic/image/width=800%2Cheight=%2Cfit=scale-down%2Cgravity=auto%2Cformat=auto/https%3A%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Farticles%2F6crxfldh3dzw86csvk00.jpg" alt="Navigating the AI Hype: Stay Smart, Stay Calm, and Stay Ahead" width="800" height="475"></a></p> <p>Everywhere you look, AI is making headlines. Influencers, media outlets, and corporate leaders are pushing the narrative that if you’re not diving headfirst into AI, your career is in jeopardy. The pressure is intense: tech gurus on social media proclaiming that if you don’t master AI today, you’ll be obsolete tomorrow. Companies restructuring, projects getting canceled, and employees getting laid off—all seemingly in the name of AI. But before you panic, let’s take a deep breath and look at this rationally.</p> <h3> The AI Hype Cycle: Who’s Benefiting? </h3> <p>The buzz surrounding AI isn’t entirely organic. There are clear beneficiaries of the widespread fear and urgency around AI adoption. Let’s break it down:</p> <ul> <li> <strong>The Media &amp; Influencers</strong> Sensational headlines, clickbait thumbnails, and dramatic narratives—media companies and social influencers thrive on engagement. The more people panic, the more clicks, views, and ad revenue they generate. Whether it’s traditional news outlets or AI-focused influencers, many stand to gain by keeping you on edge.</li> <li> <strong>Corporate Leaders &amp; Employers</strong> AI is a convenient excuse for layoffs and restructuring. If a company needs to trim its workforce, blaming AI makes it seem like an inevitable technological shift rather than a business decision. Some companies also use the AI hype to justify abandoning projects, reducing expenses, or implementing efficiency measures under the guise of AI-driven progress.</li> <li> <strong>Tech Startups &amp; Investors</strong> AI is a goldmine for startups looking to attract investors. Slap ‘AI’ on a business model, and funding is suddenly much easier to secure. While some companies are genuinely innovating with AI, others are simply capitalizing on the buzz without offering substantial technological advancements.</li> <li> <strong>Training &amp; Education Platforms</strong> The more anxiety there is around AI replacing jobs, the more online courses and training programs will sell. Many of these programs offer valuable education, but the urgency they create is often exaggerated. The reality? Not everyone needs to become an AI expert overnight.</li> </ul> <h3> How to Use AI Without Falling for the Hype </h3> <p>Rather than reacting out of fear, let’s take a strategic approach. Here’s how you can leverage AI wisely while staying grounded in reality:</p> <ul> <li> <strong>Become an AI Generalist, Not a Specialist (Yet)</strong> AI technologies are evolving rapidly. What’s groundbreaking today may be obsolete in six months. Instead of deep-diving into one specific AI tool, focus on developing a broad understanding of AI concepts and applications. This approach ensures long-term adaptability in an ever-changing tech landscape.</li> <li> <strong>Recognize Sensationalism &amp; Stay Critical</strong> If an AI-related headline or influencer claim seems exaggerated, take a step back. Consider the source, their motivations, and whether the information is based on real, practical trends or just fear-mongering.</li> <li> <strong>You Are the Architect, AI is Your Tool</strong> AI can generate code and automate tasks, but it lacks true understanding and creativity. It needs a developer who knows what they’re doing—someone who can guide it, refine its output, and make informed decisions. Without human expertise in logic, structure, and best practices, AI is just a tool without direction.</li> <li> <strong>Use AI to Expand (Not Replace) Your Skillset</strong> Instead of fearing AI as a job killer, use it as a tool to make yourself more valuable. AI can help you improve communication, enhance problem-solving skills, and even accelerate learning. Whether it’s using ChatGPT for brainstorming or leveraging AI-powered data analysis tools, think of AI as an assistant rather than a competitor.</li> <li> <strong>Explore Non-Tech Industries for AI Applications</strong> AI’s biggest opportunities aren’t just in the tech sector. Small businesses, traditional industries, and non-technical fields are ripe for AI-driven innovation. Whether it’s optimizing processes in manufacturing, improving customer experiences in retail, or streamlining logistics, there’s massive potential for applying AI outside the typical tech bubble.</li> </ul> ai careergrowth llm KeyboardInterrupt Wed, 11 Sep 2024 07:09:56 +0000 https://dev.to/keyboardinterrupt/avoiding-technical-debt-without-sacrificing-forward-momentum-2dig https://dev.to/keyboardinterrupt/avoiding-technical-debt-without-sacrificing-forward-momentum-2dig <p><a href="https://media.dev.to/cdn-cgi/image/width=800%2Cheight=%2Cfit=scale-down%2Cgravity=auto%2Cformat=auto/https%3A%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Farticles%2Fj1k0b6z2aibyxcna32xx.jpg" class="article-body-image-wrapper"><img src="https://media.dev.to/cdn-cgi/image/width=800%2Cheight=%2Cfit=scale-down%2Cgravity=auto%2Cformat=auto/https%3A%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Farticles%2Fj1k0b6z2aibyxcna32xx.jpg" alt="Avoiding Technical Debt Without Sacrificing Forward Momentum" width="800" height="600"></a></p> <p>High pressure to deliver new features and rapidly iterate on your product can lead to accumulating technical debt. While some debt is unavoidable, you can minimize it by adopting strategies that balance maintaining code quality with forward progress. This article outlines methods to help you achieve that balance.</p> <h3> <strong>Acknowledge and Accept Technical Debt</strong> </h3> <p>In the early stages of a startup, it’s common to accumulate technical debt fast! The focus is on speed and delivering value and viability, often at the expense of code quality. While this approach is necessary for gaining traction, it’s important to recognize that this debt needs to be managed as your product matures.</p> <h3> <strong>Allocate Time for Debt Reduction</strong> </h3> <p>It’s essential to allocate a specific portion of your engineering time to address technical debt. A common approach is to dedicate around 10-20% of engineering resources to this task. This allocation ensures that you are making steady progress on debt reduction while still focusing on new feature development and other priorities.</p> <h3> <strong>Adopt a Strong Architectural Foundation</strong> </h3> <p>Building a strong architectural foundation from the start is crucial. This doesn’t mean over-engineering or getting lost in perfectionism, but rather:</p> <ul> <li> <strong>Modular Design</strong> : Break your system into well-defined, modular components. This makes it easier to update or replace parts of your system without causing widespread disruption.</li> <li> <strong>Scalable Infrastructure</strong> : Consider future scaling needs and design your system to handle growth. Investing in scalable infrastructure early on can prevent costly rewrites later.</li> </ul> <h3> <strong>Implement Continuous Integration and Continuous Delivery (CI/CD)</strong> </h3> <p>CI/CD pipelines automate testing, integration, and deployment processes, which helps:</p> <ul> <li> <strong>Catch Issues Early</strong> : Automated tests run with every code change, catching bugs and regressions early, reducing the likelihood of technical debt accumulating unnoticed.</li> <li> <strong>Frequent, Small Releases</strong> : CI/CD encourages frequent, smaller releases, which are easier to manage and troubleshoot. This approach minimizes the risk of introducing large, unmanageable chunks of debt.</li> </ul> <h3> <strong>Prioritize Code Reviews and Pair Programming</strong> </h3> <p>Regular code reviews and pair programming sessions can significantly reduce the introduction of technical debt:</p> <ul> <li> <strong>Code Reviews</strong> : Establish a robust code review process where peers assess each other’s work. This not only catches potential issues but also spreads knowledge and best practices across the team.</li> <li> <strong>Pair Programming</strong> : Pair programming fosters collaboration and immediate feedback, leading to higher-quality code. It also helps distribute expertise across the team, reducing reliance on a single person’s knowledge.</li> </ul> <h3> <strong>Emphasize Documentation and Knowledge Sharing</strong> </h3> <p>Clear documentation is crucial for preventing technical debt. Well-documented and easily understood code is far simpler to revisit and refactor than a hastily written, obscure solution with no indication of its purpose or significance:</p> <ul> <li> <strong>Inline Documentation</strong> : Encourage developers to write clear, concise comments in their code. This ensures that the rationale behind decisions is easily understood, even months or years later.</li> <li> <strong>Knowledge Sharing</strong> : Regularly hold knowledge-sharing sessions, such as lunch-and-learns or internal talks. This keeps the team aligned on architectural decisions and best practices, reducing the chances of divergent, debt-inducing implementations.</li> <li> <strong>Proper Commit messages</strong> : Git is an often overlooked communication and documentation tool! A well-crafted commit message explains <em>why</em> a change was made, not just <em>what</em> was changed. This is crucial for anyone revisiting the code later, making it easier to understand the reasoning behind certain decisions.</li> </ul> <h3> <strong>Measure Technical Debt Effectively</strong> </h3> <p>Although there isn’t a perfect method to quantify technical debt, you can use several approaches to gain insights:</p> <ul> <li> <strong>Issue Trackers</strong> : Utilize issue tracking tools like Jira or GitHub. Tag issues related to tech debt and monitor their count and progress. This provides a tangible measure of the debt and helps in prioritizing fixes.</li> <li> <strong>DORA Metrics</strong> : These metrics (Deployment Frequency, Lead Time for Changes, Change Failure Rate, and Time to Restore Service) can offer indirect insights into the impact of technical debt on your engineering processes. For instance, a higher failure rate for changes may indicate underlying tech debt.</li> <li> <strong>Team Feedback</strong> : Regularly solicit feedback from your engineering team regarding the state of the codebase. Tracking their assessments over time can help gauge the level of technical debt and its impact on productivity.</li> </ul> <h3> <strong>Adopt Agile Methodologies</strong> </h3> <p>Agile methodologies help manage technical debt while keeping momentum:</p> <ul> <li> <strong>Iterative Development</strong> : Agile’s iterative approach allows for continuous improvement. By breaking down work into smaller, manageable chunks, teams can focus on delivering value while keeping technical debt in check.</li> <li> <strong>Backlog Grooming</strong> : Regularly prioritize and groom the backlog, ensuring that tech debt-related tasks are addressed alongside new feature development. This keeps the codebase healthy without stalling progress.</li> </ul> <h3> <strong>Balance Short-Term Gains with Long-Term Health</strong> </h3> <p>Avoiding technical debt doesn’t mean avoiding all shortcuts—it’s about balancing them wisely:</p> <ul> <li> <strong>Make Conscious Trade-offs</strong> : Sometimes, taking on a bit of debt is necessary to meet a deadline or seize a market opportunity. The key is to make these decisions consciously, understanding the trade-offs and planning to address them later.</li> <li> <strong>Refactoring as You Go</strong> : Incorporate small refactoring efforts into your regular development process. This approach prevents the buildup of debt while keeping the codebase clean and maintainable.</li> </ul> <h3> Double Down on Automated Testing </h3> <p>Automated testing is a critical component in avoiding technical debt:</p> <ul> <li> <strong>Unit and Integration Tests</strong> : Writing comprehensive unit and integration tests ensures that new changes don’t break existing functionality. It also provides a safety net for future development, making it easier to refactor and enhance the codebase.</li> <li> <strong>Test-Driven Development (TDD)</strong>: Adopting TDD can help ensure that code is designed with testing in mind, leading to more modular and reliable software that’s less prone to accumulating debt.</li> </ul> <h3> Conclusion </h3> <p>Avoiding technical debt while maintaining forward momentum requires a proactive approach to development. By laying a solid architectural foundation, automating processes, fostering collaboration, and making conscious trade-offs, you can build a robust, scalable product without sacrificing speed. The goal is not to eliminate technical debt entirely—an unrealistic expectation—but to manage it effectively, ensuring your codebase remains healthy and your startup continues to innovate and grow.</p> agile technicaldebth softwareentropy cicd KeyboardInterrupt Fri, 30 Aug 2024 13:02:39 +0000 https://dev.to/keyboardinterrupt/my-focusmate-experiment-9bg https://dev.to/keyboardinterrupt/my-focusmate-experiment-9bg <p><a href="https://media2.dev.to/dynamic/image/width=800%2Cheight=%2Cfit=scale-down%2Cgravity=auto%2Cformat=auto/https%3A%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Farticles%2Ff73xptzby6ppr8qxcl3j.png" class="article-body-image-wrapper"><img src="https://media2.dev.to/dynamic/image/width=800%2Cheight=%2Cfit=scale-down%2Cgravity=auto%2Cformat=auto/https%3A%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Farticles%2Ff73xptzby6ppr8qxcl3j.png" alt="My Focusmate experiment" width="800" height="478"></a></p> <p>I've recently been experimenting with <a href="https://focusmate.com/?ref=blog.keyboardinterrupt.com" rel="noopener noreferrer">Focusmate</a>, a virtual co-working platform designed to boost productivity through 25 or 75-minute sessions with a randomly chosen work partner. Here are three sessions I experienced on the platform, along with some insights.</p> <blockquote> <p>Note: Names have been randomly replaced to ensure anonymity of my mates.</p> </blockquote> <h3> Tackling my First Session with John and Breaking Out of My Comfort Zone! </h3> <p>My first session was with John, and I was a bit nervous. I’m not the most social person, so using Focusmate felt like stepping out of my comfort zone. John and I both had our tasks lined up and where ready to go: I intended on improving some metrics for one of our systems, while Jon was busy finishing his journal and generating invoices.</p> <p>While we worked on our tasks, we stayed quiet, each focused on our goals for the session. As the session came to an end, signaled by a chime, I was curious about what made Focusmate work for John. At that point, I hadn't yet felt a productivity boost—instead, my nervousness had made it easy for me to get distracted.</p> <blockquote> <p>🗨: <strong>"</strong> It helps to <em>schedule appointments and set specific goals!</em> Plus, <em>meeting new people and not wanting to disappoint them keeps me coming back</em>!"</p> </blockquote> <p>John shared his insights about Focusmate, saying, "It helps to <em>schedule appointments and set specific goals</em>. Plus, <em>meeting new people and not wanting to disappoint them keeps me coming back</em>!"<br><br> I totally got that — knowing someone else is counting on you, showing up and being there, really ups the motivation. We both wrapped up our tasks and celebrated small wins together. It was a great start!</p> <h4> <strong>Quick Burst of Productivity with Mel</strong> </h4> <p>Mel and I paired up for a short 25-minute session. I worked on improving a capacity management dashboard while Mel updated a course schedule.<br><br> The session went smoothly, and as this was my forth, or so, session, My nervousness was not as prevalent anymore. I stayed focused and on track the whole session.</p> <blockquote> <p>🗨: <em>"Working in small sessions helps break stuff down!"</em></p> </blockquote> <p>Afterwards I had a quick chat with Mel, discussing Focusmate, "<em>Working in small sessions helps break stuff down.</em>" Mel mentioned, and I agree on that.</p> <p>By the end, we were both pleased with our progress. It’s amazing how much you can accomplish in a focused burst!</p> <h4> <strong>Unexpected Moments with an Empty Chair</strong> </h4> <p>Then came a session with no one — well, almost. I was paired with someone who seemed to have pressing household chores. For two third of the session, I was working alongside an empty chair. It was kind of funny but also a bit weird.</p> <p>Despite that, I still managed to achieve my goals. When my partner eventually returned, they shared that they had made progress on their household tasks. A brief conversation revealed that they use Focusmate for various types of work and even for leisure activities. It seems that, Focusmate can be used for just about anything, and not just for office/desk Work.</p> <h4> <strong>Cancelled Plans and Understanding Mates</strong> </h4> <p>I had a session scheduled with Chris, but life got in the way. I had to cancel unexpectedly mid Session. I felt bad about it. But Chris was super understanding. Sometimes, things just come up.</p> <h4> Conclusion </h4> <p>Using Focusmate for a while, has been a surprisingly fun and productive experience. Apart from my initial nervousness or having to deal with technical difficulties. Every session has had its unique charm. It’s been great to be connect with people from different walks of life, each working on their own projects but all united by the desire to be more productive.</p> <blockquote> <p>🗨:I playfully told a colleague that Focusmate is like "a multiplayer version of the <a href="https://en.wikipedia.org/wiki/Pomodoro_Technique?ref=blog.keyboardinterrupt.com" rel="noopener noreferrer">Pomodoro technique</a>, with extra steps 🍅." This might be why it works for me—the structured sessions combined with the chance to make random connections.</p> </blockquote> <p>My main takeaway is that working "together" is more enjoyable than working alone. Combining this with organizational strategies like <u>scheduling work sessions</u> and <u>setting clear, achievable goals</u> in advance can significantly improve focus and productivity.</p> <p>I’m looking forward to more sessions, more random connections, and more productivity wins. I’ll probably keep experimenting with Focusmate and might even update this article in the future.</p> <p>What are your experiences with Focusmate or, in more general Terms, Body doubling?<br> I would love to get your perspective on this :D</p> <h3> Links and Resources: </h3> <ul> <li><a href="https://app.focusmate.com/?ref=blog.keyboardinterrupt.com" rel="noopener noreferrer">https://app.focusmate.com/</a></li> <li><a href="https://www.focusmate.com/blog/?ref=blog.keyboardinterrupt.com" rel="noopener noreferrer">https://www.focusmate.com/blog/</a></li> <li><a href="https://en.wikipedia.org/wiki/Pomodoro_Technique?ref=blog.keyboardinterrupt.com" rel="noopener noreferrer">https://en.wikipedia.org/wiki/Pomodoro_Technique</a></li> <li><a href="https://en.wikipedia.org/wiki/Body_doubling?ref=blog.keyboardinterrupt.com" rel="noopener noreferrer">https://en.wikipedia.org/wiki/Body_doubling</a></li> </ul> producitivity focusmate KeyboardInterrupt Fri, 20 Aug 2021 15:08:13 +0000 https://dev.to/keyboardinterrupt/awesome-little-online-helpers-4hj https://dev.to/keyboardinterrupt/awesome-little-online-helpers-4hj <p>Hi, 👋 today I would like to ask for your contributions! Everyone knows those neat little tools, those really helpful websites, those that you come back to every so often, those that make your life so much easier!</p> <p>I started an "Awesome List" to collect those tools, for easy reference, and to easily find them when in need ;)</p> <p><a href="https://github.com/KeyboardInterrupt/awesome-little-online-helpers" rel="noopener noreferrer">https://github.com/KeyboardInterrupt/awesome-little-online-helpers</a></p> <p>Please! add your awesome little online helper to the List.</p> <p>If you have an awesome Tool for, i don't know, a design, artificial intelligence or whatever profession/topic, please feel free to also add a new category/section as well :D</p> <p>If you don't feel like forking, and making a PR, just comment <br> on this article, I will look through them and incorporate them.</p> <p>Thank you very much! ❤ 👍</p> awesome online helper tools KeyboardInterrupt Mon, 31 Aug 2020 20:09:29 +0000 https://dev.to/keyboardinterrupt/pipx-the-brew-for-python-based-applications-gkp https://dev.to/keyboardinterrupt/pipx-the-brew-for-python-based-applications-gkp <p>When getting into python, one can easily mess up their python environment, by mixing different methods of installing Python based applications, packages, libraries and dependencies.</p> <p>A common mistake is installing Python Packages both via your Linux distributions package manager e.G. <code>apt-get</code> or <code>yum</code> and via <code>pip</code> possibly mixed with some <code>sudo pip</code> Here and there.<br> This way you are likely to mess up your Python environment with conflicting dependencies, and it is easy to loose track which Part of your Installation comes from what source...</p> <p><a href="https://pipxproject.github.io/pipx/" rel="noopener noreferrer"><code>pipx</code> comes to the rescue!</a></p> <h2> So, what does pipx do? </h2> <blockquote> <p><strong>pipx</strong> is a tool to help you install and run end-user applications written in Python. It's roughly similar to macOS's brew, JavaScript's npx, and Linux's apt.</p> <p>It's closely related to pip. In fact, it uses pip, but is focused on installing and managing Python packages that can be run from the command line directly as applications. <a href="https://pipxproject.github.io/pipx/#overview-what-is-pipx" rel="noopener noreferrer"><strong>source</strong></a></p> </blockquote> <p>Pipx provides easy installation and isolation of any python application that you can run from the commandline i.E. the <code>python-openstack</code> client, <code>ansible</code>, <code>salt</code>, <code>cookiecutter</code>, <code>black</code> and many more.</p> <p>Whilst those and other python application might interfere with each other, when mangled together in one environment.<br> When installing them via pipx Each application is automatically and individually, isolated into their own virtual Environment! 🎉</p> <p>In Example, To install <a href="https://www.ansible.com/" rel="noopener noreferrer">Ansible</a> via pipx simply run:<br> </p> <div class="highlight js-code-highlight"> <pre class="highlight shell"><code>pipx <span class="nb">install </span>ansible </code></pre> </div> <p>And viola ✨, pipx will create a virtual environment for ansible, install it, and, add all the commandline tools provided by <code>ansible</code> to your <code>$PATH</code> variable!<br> </p> <div class="highlight js-code-highlight"> <pre class="highlight plaintext"><code># pipx list venvs are in /home/keyboardinterrupt/.local/pipx/venvs apps are exposed on your $PATH at /home/cstein/.local/bin package ansible 2.9.10, Python 3.6.9 - ansible - ansible-config - ansible-connection - ansible-console - ansible-doc - ansible-galaxy - ansible-inventory - ansible-playbook - ansible-pull - ansible-test - ansible-vault </code></pre> </div> <p>I usually use pipx for installation of python based applications and only ever use virtual environments and pip directly whenever I am developing.</p> <p><a href="https://pipxproject.github.io/pipx/" rel="noopener noreferrer">I highly recommend checking out pipx!</a> It is a great tool to keep your python based tools neatly organized, ready to use, and easy to upgrade.</p> <p>I ❤ <code>pipx</code></p> <h2> Links and Resources </h2> <ul> <li><a href="https://pipxproject.github.io/pipx/#overview-what-is-pipx" rel="noopener noreferrer">pipx</a></li> <li><a href="https://pythonbytes.fm/episodes/show/118/better-python-executable-management-with-pipx" rel="noopener noreferrer">Python Bytes Podcast - Episode #118: Better Python executable management with pipx </a></li> <li><a href="https://pipxproject.github.io/pipx/comparisons/" rel="noopener noreferrer">pipx in comparison to other/similar tools</a></li> <li><a href="https://blog.keyboardinterrupt.com/use-pipx-for-installing-python-software/" rel="noopener noreferrer">Pipx, the brew for python based Applications</a></li> </ul> <blockquote> <p>Cover Art Image by <a href="https://www.pexels.com/photo/beige-python-on-brown-branch-of-tree-1108192/" rel="noopener noreferrer">@worldspectrum</a></p> </blockquote> python productivity KeyboardInterrupt Wed, 26 Aug 2020 20:21:28 +0000 https://dev.to/keyboardinterrupt/poor-man-s-tools-that-are-actually-awesome-22fh https://dev.to/keyboardinterrupt/poor-man-s-tools-that-are-actually-awesome-22fh <p>These are 3 of the more outstanding Linux (and MAC) Tools which I use on a regular basis.</p> <p>I can highly recommend all of them, they made my live a lot easier! :)</p> <h2> <code>lnav</code> - Poor Man's ELK Stack </h2> <p><a href="https://media.dev.to/cdn-cgi/image/width=800%2Cheight=%2Cfit=scale-down%2Cgravity=auto%2Cformat=auto/https%3A%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fi%2Fgq38aqzp5nvgki625icg.png" class="article-body-image-wrapper"><img src="https://media.dev.to/cdn-cgi/image/width=800%2Cheight=%2Cfit=scale-down%2Cgravity=auto%2Cformat=auto/https%3A%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fi%2Fgq38aqzp5nvgki625icg.png" alt="lnav on an auth.log (yes ssh is on port 22 on this system.)" width="800" height="536"></a></p> <p>If you regularly have to deal with Log files I highly recommend checking out <code>lnav</code>. <code>lnav</code> is so freaking cool that I probably will have to Write a whole article about it eventually, but trust me on this, if you are on Linux or Mac and have to deal with log files. Check out <code>lnav</code>.</p> <p>Just a quick overview of some of the things lnav can do:</p> <ul> <li>Automatically detects log Formats, merges multiple log files into a single view and decompresses GZIP'ed and BZIP2'ed files on the fly</li> <li>Syntax Highlighting!</li> <li> <strong>Filter</strong> Log files via regular Expressions! (press <code>:</code> to get a command palette)</li> <li>The <strong>Timeline View</strong> shows a histogram of Messages over time. (By pressing <code>i</code>)</li> <li>XML and JSON in log messages can be pretty Viewed. (by pressing <code>SHIFT + P</code>)</li> <li>Use <code>SQL</code> to Query Logs! (srsly!)</li> <li>VIM Key Bindings</li> <li>Easy Log Navigation</li> </ul> <p>And so on! This is just the tip of the iceberg! Give lnav a try it's a poor man's ELK ;) </p> <ul> <li><a href="https://lnav.org/" rel="noopener noreferrer">https://lnav.org/</a></li> <li><a href="https://lnav.readthedocs.io/en/latest/" rel="noopener noreferrer">https://lnav.readthedocs.io/en/latest/</a></li> <li><a href="https://lnav.readthedocs.io/en/latest/hotkeys.html" rel="noopener noreferrer">https://lnav.readthedocs.io/en/latest/hotkeys.html</a></li> </ul> <h2> <code>sshuttle</code> - Poor Man's VPN </h2> <p>Sometimes you want to test a service, or access hosts that are running in a different Network which is only accessible via a Jump/Bastion Host, or maybe you are constantly adding more and more Ports to your SSH Port Forwarding configuration. What you really would like to have is VPN access into said Network to gain unhindered access to all the systems in it.</p> <p>That is where <code>sshuttle</code> comes into play, given that you have a SSH Jump/Bastion host, that is able to access all the Network Resources you want direct access to, you can just run the following command on your System:<br> </p> <div class="highlight js-code-highlight"> <pre class="highlight shell"><code>sshuttle <span class="nt">-r</span> username@jumphost &lt;target_subnet&gt; </code></pre> </div> <p>And voila! All traffic for <code>&lt;target_subnet&gt;</code> will be tunneled/routed through the Jumphost <code>sshuttle</code>. To tear down the tunnel, simply close <code>sshuttle</code> and your routing is back to normal!</p> <p><code>sshuttle</code> comes with a few limitations which makes it "only" a poor man's vpn, but it is a really useful Tool for a lot of situations! Check it out!</p> <ul> <li><a href="https://github.com/sshuttle/sshuttle" rel="noopener noreferrer">https://github.com/sshuttle/sshuttle</a></li> <li><a href="https://sshuttle.readthedocs.io/en/stable/" rel="noopener noreferrer">https://sshuttle.readthedocs.io/en/stable/</a></li> </ul> <p><em>PS: For real VPN, <a href="https://www.wireguard.com/" rel="noopener noreferrer">check out Wireguard!</a> 💚</em></p> <h2> <code>netdata</code> - Poor Man's Metrics / Monitoring and "top" on Steroids! </h2> <p>Netdata is a Web based and lightweight Metrics and Monitoring Solution, It is a great Tool to get Metrics and Graphs of your Systems NOW, e.G. in a situation where your traditional monitoring does either not provide the right Metrics or is to slow.<br> Netdata, unlike more traditional Monitoring Solutions, which do a poll for metrics only ever so often, is best compared to "top" but on steroids! 💪 and in beautiful ✨.</p> <p><a href="https://res.cloudinary.com/practicaldev/image/fetch/s--BGyA6LCg--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_66%2Cw_800/https://user-images.githubusercontent.com/1153921/80827388-b9fee100-8b98-11ea-8f60-0d7824667cd3.gif" class="article-body-image-wrapper"><img src="https://res.cloudinary.com/practicaldev/image/fetch/s--BGyA6LCg--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_66%2Cw_800/https://user-images.githubusercontent.com/1153921/80827388-b9fee100-8b98-11ea-8f60-0d7824667cd3.gif" alt="Netdata Demo GIF from Github" width="720" height="405"></a></p> <p>Netdata Is not a long term Monitoring solution, in its default configuration no more than a few Hours of Metrics are stored, But it is a really great Tool to either find out which metrics you actually would like to monitor and for debugging of acute problems. In this regard, it is a poor man's Monitoring.</p> <ul> <li><a href="https://learn.netdata.cloud/#installation" rel="noopener noreferrer">https://learn.netdata.cloud/#installation</a></li> <li><a href="https://learn.netdata.cloud/docs/agent/demo-sites" rel="noopener noreferrer">https://learn.netdata.cloud/docs/agent/demo-sites</a></li> <li><a href="https://learn.netdata.cloud/docs/agent/packaging/docker" rel="noopener noreferrer">https://learn.netdata.cloud/docs/agent/packaging/docker</a></li> </ul> <p>That's it for now. I hope That you got something out of this List, and that I was able to introduce you to a Tool that will make your live easier!</p> <p><strong>Do you know of any Tools that are awesome in similar ways?</strong> They don't have to be a Poor Man's Version of something, Leave a comment, and let me know! I am always on the look out for Tools that help me automate, and improve my work!</p> linux productivity bash docker KeyboardInterrupt Sun, 02 Sep 2018 14:16:15 +0000 https://dev.to/keyboardinterrupt/tips-and-resources-for-writing-better-shell-scripts-4l9l https://dev.to/keyboardinterrupt/tips-and-resources-for-writing-better-shell-scripts-4l9l <p><a href="https://media.dev.to/cdn-cgi/image/width=800%2Cheight=%2Cfit=scale-down%2Cgravity=auto%2Cformat=auto/https%3A%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Farticles%2Fi34g3vne0w4xukm6d52u.png" class="article-body-image-wrapper"><img src="https://media.dev.to/cdn-cgi/image/width=800%2Cheight=%2Cfit=scale-down%2Cgravity=auto%2Cformat=auto/https%3A%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Farticles%2Fi34g3vne0w4xukm6d52u.png" alt="Tips and Resources for writing better Shell Scripts" width="640" height="400"></a></p> <blockquote> <p><strong>Updated July 2020:</strong> I added a Section about Shell Script Headers.</p> </blockquote> <p>It is easy to write bad shell scripts, and there is a lot of room for mistakes!, possibly the best tip one could give is to use a higher-level language, like python, and try to avoid writing shell scripts at all. But if you just have to, or want to, here are some helpful Tips/Resources you can use to write better shell scripts ;)</p> <h2> Use the Google Shell Style Guide </h2> <p>Using a consistent coding style among your Team/Company is important, the same applies to shell scripts as well! Try to find out if there already exists a guideline within your Structure, and adopt it.<br><br> If there is none in place, you should take a look at Googles <a href="https://google.github.io/styleguide/shell.xml?ref=blog.keyboardinterrupt.com" rel="noopener noreferrer">Shell Style Guide</a> which is a really great reference! (<em>Maybe also check out <a href="https://google.github.io/styleguide/?ref=blog.keyboardinterrupt.com" rel="noopener noreferrer">their other Style Guides</a></em>)</p> <h2> Use ShellCheck for linting </h2> <p>While using Linters with "real" programming languages, like python, is the default and most specialized IDE's have linting functionality neatly integrated, most people don’t think about linting their bash scripts, as they are just considered to be "<em>quick hacks or whatever</em>".</p> <p>Nevertheless it comes as a surprise that there also exist linters for bash and <a href="https://github.com/koalaman/shellcheck?ref=blog.keyboardinterrupt.com" rel="noopener noreferrer">ShellCheck</a> is a really good one!<br><br> You can easily install it locally and/or try it on-line by visiting <a href="https://www.shellcheck.net/?ref=blog.keyboardinterrupt.com" rel="noopener noreferrer">www.shellcheck.net</a> (<em>don't blindly copy and paste your secrets into that, or any other website ;)</em> )</p> <p>Most modern Text editors like Sublime or Atom also have a great ShellCheck integration, give it a try!</p> <h2> Use Shell settings to increase script safety </h2> <p>If a command within your shell script goes wrong, a variable is not set or a piped command errors, the default behavior of bash is to, more or less, silently fail and go on with the script, as if nothing happened. This can be rather dangerous, and often results in unintended script behavior.</p> <p>To increase script safety and avoid unintended behavior, you must explicitly tell your shell to automatically exit when an error occurs!</p> <p>This can be done by setting <code>set -eu -o pipefail</code> at the beginning of your script you tell bash to stop and exit immediately when a Step fails!<br><br> Read more about writing safe shell scripts, over here <a href="https://sipb.mit.edu/doc/safe-shell/?ref=blog.keyboardinterrupt.com" rel="noopener noreferrer">https://sipb.mit.edu/doc/safe-shell/</a></p> <h2> Put a descriptive Header at the Start of your script </h2> <p>Even though Shellscripts are often intended as "throwaway" Solution or a "dirty quick fix" They more often than not, become permanent fixtures in critical Systems!</p> <p>By providing a descriptive Header with additional context at the start of your shell script, you can easily improve the lives of anyone stumbling upon your "quick fix", possibly years later.<br><br> Especially adding the <code>author</code> Information helps track down the Person that knows what's up, when needed.</p> <p>i.E. this is the example header for a fictive Fish feeding shell script. (imagine a robotic fish feeder controlled via an http API. 🤖🐠🤷, No fish have been harmed!)<br> </p> <div class="highlight js-code-highlight"> <pre class="highlight plaintext"><code>#!/bin/bash #title :feed_the_fish.sh #description :This script feeds the Fish, via controlling the feed-the-fish.com API. #author :frank.fish@example.com #date :2017-05-20 #version :0.2.1 #usage :bash feed_the_fish.sh #notes :This script depends on curl to call the fish API. #bash_version :4.2.1(1)-release </code></pre> </div> <p>Having such a Header is a nice way keep a track of what your script does, when it was created, the author of the script, etc..</p> <h3> Update: how to write <code>idempotent</code> Shell Scripts: </h3> <p>I Recently found <a href="https://arslan.io/2019/07/03/how-to-write-idempotent-bash-scripts/?ref=blog.keyboardinterrupt.com" rel="noopener noreferrer">this Blog Post</a>, and I think it is a great addition to this topic!</p> <p>Beware though that some of the Actions described in the Blog Post are <strong>NOT</strong> truly idempotent, as i.E. <code>touch</code> will alter the modification time of the file, and forcefully creating/recreating/deleting things are changes! But the Ideas and Concepts conveyed in this Article are good non the less, and it is an interesting Read!</p> <p><a href="https://arslan.io/2019/07/03/how-to-write-idempotent-bash-scripts/?ref=blog.keyboardinterrupt.com" rel="noopener noreferrer">https://arslan.io/2019/07/03/how-to-write-idempotent-bash-scripts/</a></p> <blockquote> <p>You still should use a Tool like Ansible or another truly idempotent Configuration Management Solution in most cases anyway tough!</p> </blockquote> <h3> Update: Use explainshell.com for explanation on what your Shell Script does. </h3> <p><a href="https://explainshell.com/?ref=blog.keyboardinterrupt.com" rel="noopener noreferrer">https://explainshell.com/</a></p> <blockquote> <p><a href="https://github.com/idank/explainshell?ref=blog.keyboardinterrupt.com" rel="noopener noreferrer">"Explainshell is a tool (with a web interface) capable of parsing man pages, extracting options and explain a given command-line by matching each argument to the relevant help text in the man page."</a></p> </blockquote> <h2> references and further reading material </h2> <ul> <li> <a href="https://sipb.mit.edu/doc/safe-shell/?ref=blog.keyboardinterrupt.com" rel="noopener noreferrer">https://sipb.mit.edu/doc/safe-shell/</a> </li> <li> <a href="https://www.linux.com/learn/writing-simple-bash-script?ref=blog.keyboardinterrupt.com" rel="noopener noreferrer">https://www.linux.com/learn/writing-simple-bash-script</a> </li> <li> <a href="https://guide.bash.academy/?ref=blog.keyboardinterrupt.com" rel="noopener noreferrer">https://guide.bash.academy/</a> </li> <li> <a href="https://google.github.io/styleguide/shell.xml?ref=blog.keyboardinterrupt.com" rel="noopener noreferrer">https://google.github.io/styleguide/shell.xml</a> </li> <li> <a href="https://www.shellcheck.net/?ref=blog.keyboardinterrupt.com" rel="noopener noreferrer">https://www.shellcheck.net/</a> </li> <li><a href="https://landoflinux.com/linux_bash_scripting_structure.html?ref=blog.keyboardinterrupt.com" rel="noopener noreferrer">https://landoflinux.com/linux_bash_scripting_structure.html</a></li> </ul> linux bash shell